Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Local Documentation Builds UX Could Be Better #3480

Open
dnwillia-work opened this issue Nov 13, 2024 · 0 comments
Open

Local Documentation Builds UX Could Be Better #3480

dnwillia-work opened this issue Nov 13, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@dnwillia-work
Copy link
Collaborator

dnwillia-work commented Nov 13, 2024

Description of the modifications

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:

python doc/api_rstgen.py
python doc/datamodel_rstgen.py
python doc/tui_rstgen.py
python doc/settings_rstgen.py

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.

@dnwillia-work dnwillia-work added the documentation Improvements or additions to documentation label Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant