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.

Sign up for GitHub

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

Jump to bottom

Improve Sphinx documentation build process #388

Closed
MicahGale opened this issue Mar 9, 2024 · 0 comments · Fixed by #380
Closed

Improve Sphinx documentation build process #388

MicahGale opened this issue Mar 9, 2024 · 0 comments · Fixed by #380
Labels
CI/CD documentation Improvements or additions to documentation feature request An issue that improves the user interface.

Comments

@MicahGale
Copy link
Collaborator

Two quick ideas.

  1. Sphinx embeds the version number of montepy in the documentation. So it should be built, after the package is built, and therefore after the package number is bumped.
  2. The changelog refers to Github Issues a lot. Consider adding a sphinx extension to autolink them. See this package, and this stackoverflow.
@MicahGale MicahGale added documentation Improvements or additions to documentation CI/CD feature request An issue that improves the user interface. labels Mar 9, 2024
@MicahGale MicahGale mentioned this issue Mar 9, 2024
Merged
1 task
@MicahGale MicahGale mentioned this issue Apr 17, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
CI/CD documentation Improvements or additions to documentation feature request An issue that improves the user interface.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Impove Community documentation idaholab/MontePy
1 participant
@MicahGale