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

Improve documentation build logic #501

Open
moe-ad opened this issue Nov 26, 2024 · 0 comments · May be fixed by #502
Open

Improve documentation build logic #501

moe-ad opened this issue Nov 26, 2024 · 0 comments · May be fixed by #502
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@moe-ad
Copy link
Contributor

moe-ad commented Nov 26, 2024

Description of the modifications

While working on #490 and ansys-internal/pyansys-planning#96, it was observed that the build process of the documentation can be improved. Currently, pre-build scripts and build commands are being executed through tox.

However, best practice requires code related to documentation build to be located within the conf.py file and "sphinx build ..." command is preferred to the "make ..." command since the former is OS agnostic unlike the latter (which is what is currently being used through tox).

Useful links and references

The following is recommended:

  • The code in the pre-build script should be moved to conf.py.
  • Conf.py should be modified accordingly to run this code.
  • Documentation build should be done with "sphinx build " command.
@moe-ad moe-ad added the documentation Improvements or additions to documentation label Nov 26, 2024
@moe-ad moe-ad linked a pull request Nov 28, 2024 that will close this issue
3 tasks
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

Successfully merging a pull request may close this issue.

1 participant