You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When generating the documentation it would be good if all the required commands are executed by doc/make.bat or doc/Makefile. Right now you have to manually execute these commands:
before running the build. These seem to be in the main repo Makefile but the instructions on the documentation tell users to run make html in the doc area so these do not get built currently.
The settings_rstgen.py script depends on a Fluent version. It would be good to be able to pass that as a command line argument. Current workflow is inspect the code and figure out that you need to do this:
set FLUENT_IMAGE_TAG=v251
If I could just python/settings_rstgen.py --help to inspect for a necessary cmd line arg or at least mention that I should set this variable, that would be great.
The text was updated successfully, but these errors were encountered:
Description of the modifications
When generating the documentation it would be good if all the required commands are executed by
doc/make.bat
ordoc/Makefile
. Right now you have to manually execute these commands:before running the build. These seem to be in the main repo Makefile but the instructions on the documentation tell users to run
make html
in thedoc
area so these do not get built currently.The
settings_rstgen.py
script depends on a Fluent version. It would be good to be able to pass that as a command line argument. Current workflow is inspect the code and figure out that you need to do this:If I could just
python/settings_rstgen.py --help
to inspect for a necessary cmd line arg or at least mention that I should set this variable, that would be great.The text was updated successfully, but these errors were encountered: