docs: Generate docs using sphinx-autoapi #52
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
navasvarela
requested review from
Jmgr,
lumasepa,
manel1874,
jcabrero,
pablojhl and
nilmemo
navasvarela
force-pushed
the
docs/sphinx-autoapi
branch
from
a308d62 to
7d2b287
Compare
navasvarela
force-pushed
the
docs/sphinx-autoapi
branch
from
7d2b287 to
448ed51
Compare
lumasepa
approved these changes
Nov 13, 2024
pablojhl
approved these changes
Nov 13, 2024
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.
Changes
The current API docs are not complete, and they have broken links.
Autogenerate Sphinx documentation using
sphinx-autoapi. This extension generates a more complete API documentation that is easier to maintain.Also moving tests to a dedicated
testsfolder.Merge requirement checklist