ansys / ansys/pymechanical

Doc: Use variable substitution for Mechanical version in doc build

Open
#1,239 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Python
Stars
83
Forks
37
Avg merge
23h 48m
Merged PRs (30d)
25

Description

We are using current mechanical versions in lot of places. Ideally it should be done when sphinx build happening. Currently there is no way to do variable sub inside code block ( as far as I know. I might be wrong).

Contributor guide

Open the contributing guide

Research direction

Start by locating the Sphinx documentation build configuration and the docs that contain Mechanical version values. Check how substitutions are currently handled, then make the version available during the build, including where it appears in code blocks. Done means the documentation build succeeds and no longer requires repeated hard-coded version updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.