Add autogenerated api docs. #641
Open
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
```
sphinx-quickstart --sep --project=OpenHTF --author="OpenHTF Contributors" \
--language=en --ext-viewcode --ext-autodoc --makefile --batchfile --suffix=.rst \
--master=index docs
```
|
This is currently interfering with |
jettisonjoe
suggested changes
Nov 30, 2017
|
This should be compatible with readthedocs, but the openhtf project is
owned by maddychan so I can't point it at this branch temporarily to see it
working.
…On Thu, Nov 30, 2017 at 2:46 PM, Joe Ethier ***@***.***> wrote:
***@***.**** requested changes on this pull request.
Can we get a hosted version of the built docs up somewhere so we can take
a look?
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#641 (review)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AASrtBYCh5hErLH6RY-QrU8rEzOBm1xOks5s7zBXgaJpZM4O8yAa>
.
|
|
@fahhem, Maddy just added us as maintainers to the OpenHTF readthedocs project. |
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 is a first crack at generating api docs from docstrings using Sphinx. I've decided to use PBR for this. I've seen it used in various other projects recently, and it seems to work well. The alternative is to use
sphinx-autogen, but it isn't as automatic and the output is a bit messy. There are other useful things it can do as well, but I haven't configured that.Things that this PR doesn't address:
This change is