Johny b/585 api reference sphinx #622
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
Run: `poetry run poe sphinx-markdown` Result: `build/markdown/index.md`
Co-authored-by: johny-b <[email protected]>
Now we have 2 files and the main (the one we want to send people to) is `api.html`, not `index.html`.
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.
Rendered version:
https://yapapi.readthedocs.io/en/johny-b-readthedocs-test/api.html
(It's rendered from another branch because I had some troubles with refreshing readthedocs, but the code is the same. Readthedocs integration should be improved in #625 )
There are a lot of lines in the diff, but most of changes are links inside the docs, so e.g.
`Golem`->:class:`~yapapi.Golem`.There were few bigger changes:
SummaryLogger- removed references to the Executor classScript- moved param documentation to:params:section @zakaprov(Reminder: we're not aiming for a perfect version, just a good enough one).