Add mkdocstrings for automatic reference documentation #58
Conversation
This file contains hidden or 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
Midnighter force-pushed the add-mkdocstrings branch from 038a9c3 to 4640faa Compare 
Codecov Report
@@ Coverage Diff @@ ## devel #58 +/- ## ======================================= Coverage 90.60% 90.60% ======================================= Files 69 69 Lines 2108 2108 Branches 208 208 ======================================= Hits 1910 1910 Misses 177 177 Partials 21 21 Continue to review full report at Codecov.
|
Midnighter force-pushed the add-mkdocstrings branch from 4640faa to 1eca9f1 Compare Installation is required for cross-references.
Readthedocs uses `python setup.py install` rather than `pip install` bypassing many modern installation features.
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.
Add reference/API documentation with mkdocstrings.