Build Sphinx API docs under TravisCI/Tox using apidoc #1803
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
Codecov Report
@@ Coverage Diff @@
## master #1803 +/- ##
==========================================
- Coverage 85.46% 85.46% -0.01%
==========================================
Files 301 301
Lines 49308 49308
==========================================
- Hits 42140 42139 -1
- Misses 7168 7169 +1
Continue to review full report at Codecov.
|
|
Cross reference http://mailman.open-bio.org/pipermail/biopython/2018-October/016549.html for thoughts on where to put the docs online, leaning to GitHub Pages under |
peterjc
force-pushed
the
travis_sphinx_1_8
branch
from
b192377
to
1a00aa5
Compare
We trigger sphinx-apidoc from sphinx's conf.py In theory this would allow readthedocs to be used and generate the API documentation *.rst files on demand. Uses autodoc_default_values added in Sphinx 1.8.0
This reverts commit e6cc67b.
peterjc
force-pushed
the
travis_sphinx_1_8
branch
4 times, most recently
from
83a78cf
to
62fdeda
Compare
I wanted to check only *.rst with: $ doc8 -e .rst . Sadly this is broken by design, the bug is that as per their README file, the "extension" option does not override, but merges, so cannot remove anything from the default of .rst and .txt files.
3 tasks
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.
This pull request would in part address issue #906, the goal of replacing epydoc for our API documentation. Squashed version of the work-in-progress on #1388.
Note uses autodoc_default_values added in Sphinx 1.8.0
I hereby agree to dual licence this and any previous contributions under both
the Biopython License Agreement AND the BSD 3-Clause License.
I have read the
CONTRIBUTING.rstfile and understand that AppVeyor andTravisCI will be used to confirm the Biopython unit tests and
flake8stylechecks pass with these changes.
I have added my name to the alphabetical contributors listings in the files
NEWS.rstandCONTRIB.rstas part of this pull request, am listedalready, or do not wish to be listed. (This acknowledgement is optional.)