Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add InterSphinx Support and Switch from autoapi to autodoc #17

Open
medley56 opened this issue Jan 8, 2024 · 0 comments
Open

Add InterSphinx Support and Switch from autoapi to autodoc #17

medley56 opened this issue Jan 8, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@medley56
Copy link
Owner

medley56 commented Jan 8, 2024

Intersphinx allows linking between documentation sources generated with Sphinx and autodoc. The documentation generated for space-packet-parser should include the intersphinx extension so that other documentation sources can link to it.

As part of this work, the documentation generator for space-packet-parser should also be switched to the built in autodoc/autosummary instead of the separate sphinx-autoapi package.

@medley56 medley56 added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 19, 2024
@medley56 medley56 added this to the Version 5.0.0 Release milestone Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant