Enable API doc generation #802
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
ghost
requested review from
cheng-kevin and
lywong92
and removed request for
a team
ryanjulian
approved these changes
Jul 16, 2019
Codecov Report
@@ Coverage Diff @@
## master #802 +/- ##
==========================================
+ Coverage 73.25% 73.27% +0.01%
==========================================
Files 175 175
Lines 10274 10274
Branches 1308 1308
==========================================
+ Hits 7526 7528 +2
+ Misses 2377 2375 -2
Partials 371 371
Continue to review full report at Codecov.
|
This commit enables generation of api docs from docstrings. It - adds a minimal requirements.txt to allow installation on readthedocs - adds readthedocs.yml to allow configuring readthedocs settings from code - adds some packages to autodoc_mock_imports to mock them for generating docs without installation since readthedocs doesn't allow installing packages with C library deps, and allows limited memory usage - allows writing docs in markdown
ryanjulian
requested review from
a team
and removed request for
cheng-kevin and
lywong92
ghost
requested review from
cheng-kevin and
lywong92
and removed request for
a team
yonghyuc
pushed a commit
that referenced
this pull request
Jul 30, 2019
* Adds a minimal requirements.txt to allow installation on ReadTheDocs * Adds readthedocs.yml to allow configuring ReadTheDocs settings from code - Adds some packages to autodoc_mock_imports to mock them for generating docs without installation, since ReadTheDocs doesn't allow installing packages with C library deps, and allows limited memory usage - Allows writing docs in markdown * Updated the documentation link in README.md
gitanshu
added a commit
that referenced
this pull request
Nov 5, 2019
gitanshu
added a commit
that referenced
this pull request
Nov 5, 2019
gitanshu
added a commit
that referenced
this pull request
Nov 5, 2019
gitanshu
added a commit
that referenced
this pull request
Nov 5, 2019
gitanshu
added a commit
that referenced
this pull request
Nov 5, 2019
gitanshu
added a commit
that referenced
this pull request
Nov 5, 2019
gitanshu
added a commit
that referenced
this pull request
Nov 5, 2019
gitanshu
added a commit
that referenced
this pull request
Nov 5, 2019
gitanshu
added a commit
that referenced
this pull request
Nov 5, 2019
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 #755
Closes #647