Update Sphinx config #415
Merged
Update Sphinx config #415
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update the requirements files, especially for the documentation. Fix up the conf.py file for configuring the Sphinx build. Add explicitly the AutoAPI templates. Update the "homepage" index file to include a nicer ToC.
These tests are absolutely HORRIBLE!!!!
quaat
approved these changes
Jan 4, 2023
Yeah. Bad practice, sorry. Some are a bit unrelated, most are indirectly related though. |
This was referenced Jan 4, 2023
|
@daniel-sintef I have created #416 and #417 as follow-up tasks/issues. This should cover it for now? |
…e-clean-sphinx-config
…e-clean-sphinx-config
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #400
This is a rather lengthy PR and may require several rounds of review.
The goal is to update the Sphinx configuration (
conf.py) file and remove (or reduce as much as possible) the build warnings/errors. As the main part of these warnings are currently emitted from the auto-generated API documentation, this means updating the doc-strings where necessary.The
triplestoremodule has been stripped of everything except theunitsfiles.Currently, the warnings/errors present pertain to these parts:
share/dlite/mapping-plugins/.dliteanddlite.dlite.Concerning point 1, this is due to duplications in some methods or similar that are defined both in the C code and included Python files. Or it may be due to overloaded functions, something that Sphinx and AutoAPI cannot handle.
For point 2, this will be solved by #412.
The multiple cross-references in point 3 is something that may be fixable in this PR. I need to investigate this further.