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.
With this PR we can have HTTP API documentation. However, this requires some little change to the command you use to generate documentation. Please note: just sticking to the current commands does not break anything: you will only miss what I added.
Just tell me how
Here is what you used to do till today:
which is great. If you do it after merging this, you will see
Despite the warning, there is no error: documentation is still built, but the "HTTP API" page is empty.
Do what it says, and your favourite command will produce HTTP API, too.
The theory
The sphinx extension that does all the magic must be installed. You could do it running
pip install sphinxdomain-httpcontrib
but that's so unelegant. The right way is specify an "extras set" insidesetup.py
;doc
sounds like a good name for it. After that, you can just install it withpip install .[doc]
and everything works. Except that extra set in local directory are only supported inpip >= 7
, which is still not very widespread. Sopip install -U pip
will install it; after that, you can install libreant with thedoc
extra set.This will require some small change to readthedocs configuration. This will close #168