DOC: Fix Sphinx documentation #180
Merged
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
jhlegarreta
force-pushed
the
FixSphinxDocumentation
branch
from
d327c4a to
407615a
Compare
jhlegarreta
force-pushed
the
FixSphinxDocumentation
branch
from
407615a to
7acafa0
Compare
Fix Sphinx documentation: - Add a pre-build task to the `readthedocs` config file in order to generate the `rst` files from the package docstrings so that Sphinx build the HTML files from them. - Add the `napoleon` extension to the Sphinx config file so that it can parse NumPy and Google style docstrings. - Fix the `index.rst` file so that the package API is effectively displayed: set `whitematterpackage` as the entry for the reference section. - Set the `bin` and `utilities` packages as the entries for the scripts section in the `index.rst` file.
jhlegarreta
force-pushed
the
FixSphinxDocumentation
branch
from
7acafa0 to
a45a7ae
Compare
|
The patch set is doing its job: the package documentation is now displayed. Further improvements are left for separate PRs. Merging. |
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.
Fix Sphinx documentation:
readthedocsconfig file in order togenerate the
rstfiles from the package docstrings so that Sphinxbuild the HTML files from them.
napoleonextension to the Sphinx config file so that it canparse NumPy and Google style docstrings.
index.rstfile so that the package API is effectivelydisplayed: set
whitematterpackageas the entry for the referencesection.
binandutilitiespackages as the entries for the scriptssection in the
index.rstfile.