Fix autodoc Python API reference #1176
Closed
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
It generates `doc/py_reference.rst` if the Arbor Python package is importable. This file should be checked in, such that the Python API references will be generated even if `arbor` can't be imported (on RTD). On occasion, it should be updated. * Added `doc/py_reference_generator.rst`. It is required to cause autodoc to be run.
brenthuisman
added
documentation
brenthuisman
changed the title
doc/scripts/autodoc_cache.py.
bcumming
requested changes
Oct 6, 2020
There was a problem hiding this comment.
Can we just not include automatically generated docs?
- This is a big file, and I want to understand its impact on the size of the repository.
- Every option like increases our surface area for bugs and issues building the docs
Let's stabilise the docs first, before adding more features like this.
|
No longer required, Arbor builds on RTD. |
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.
doc/scripts/autodoc_cache.py. It generatesdoc/py_reference.rstif the Arbor Python package is importable.doc/py_reference.rstshould be checked in, such that the Python API references will be generatedeven if
arborcan't be imported (on RTD).On occasion, it should be updated by building the docs locally and git adding
py_reference.rst.doc/py_reference_generator.rst. It is required to cause autodoc to be run.Provides a fix for #1172