-
Notifications
You must be signed in to change notification settings - Fork 6
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
API Documentation with Sphinx #75
Merged
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
This reverts commit fa1b20d.
… 72-api-documentation-with-sphinx
adamamer20
added
docs
Improvements or additions to documentation
ci
Changes to CI configuration files and scripts.
labels
Aug 24, 2024
Codecov ReportAttention: Patch coverage is
|
rht
reviewed
Aug 24, 2024
rht
approved these changes
Aug 24, 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.
This PR adds a simple API documentation built with sphinx and automatically deployed with GH Action.
I had to use a custom GH Action to deploy general docs (mkdocs) and API docs (sphinx) at the same time.
I also had to create a custom decorator to "inherit" class docstrings in the case of multiple inheritance (like GridPandas, AgentSetPandas, ...).
The GH Action is set to be deployed on every push to this branch. I will update to 'main' when merged.
You can preview the look of API docs with the current PR here: https://adamamer20.github.io/mesa-frames/api/index.html
This PR depends on #74