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

Sphinx configuration improvements #237

Merged
merged 3 commits into from
Sep 3, 2024
Merged

Sphinx configuration improvements #237

merged 3 commits into from
Sep 3, 2024

Conversation

benoit9126
Copy link
Member

@benoit9126 benoit9126 commented Jul 9, 2024

Small improvements of the Sphinx configuration:

  • Delete the autodoc configuration part (we are using autoapi)
  • Add some Intersphinx mappings
  • Delete the warning for the roseau.load_flow_engine.cy_engine module which is not found when generating the documentation.

@alihamdan By the way, the command make linkcheck already exists and checks all the external links found in the documentation. We should run it sometimes to ensure the documentation is up-to-date.

@benoit9126 benoit9126 added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 9, 2024
@benoit9126 benoit9126 self-assigned this Jul 9, 2024
@benoit9126 benoit9126 marked this pull request as draft July 11, 2024 06:53
@benoit9126 benoit9126 marked this pull request as ready for review September 3, 2024 13:29
@benoit9126
Copy link
Member Author

There is still a bug in sphinx-autoapi readthedocs/sphinx-autoapi#473 that needs to be solved to have a better documentation (ie. API doc similar to the "API Reference" section for each model)

@benoit9126 benoit9126 merged commit 919c19e into develop Sep 3, 2024
4 checks passed
@benoit9126 benoit9126 deleted the sphinx branch September 3, 2024 13:35
@benoit9126 benoit9126 mentioned this pull request Sep 3, 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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant