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

API Documentation with Sphinx #75

Merged
merged 59 commits into from
Aug 24, 2024
Merged

Conversation

adamamer20
Copy link
Collaborator

@adamamer20 adamamer20 commented Aug 24, 2024

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

@adamamer20 adamamer20 linked an issue Aug 24, 2024 that may be closed by this pull request
@adamamer20 adamamer20 requested a review from rht August 24, 2024 16:29
@adamamer20 adamamer20 self-assigned this Aug 24, 2024
@adamamer20 adamamer20 added docs Improvements or additions to documentation ci Changes to CI configuration files and scripts. labels Aug 24, 2024
Copy link

codecov bot commented Aug 24, 2024

Codecov Report

Attention: Patch coverage is 94.11765% with 1 line in your changes missing coverage. Please review.

Files Patch % Lines
mesa_frames/utils.py 87.50% 1 Missing ⚠️
Files Coverage Δ
mesa_frames/abstract/agents.py 89.21% <ø> (ø)
mesa_frames/concrete/agents.py 95.56% <ø> (ø)
mesa_frames/concrete/model.py 75.86% <ø> (ø)
mesa_frames/concrete/pandas/agentset.py 88.34% <100.00%> (+0.10%) ⬆️
mesa_frames/concrete/pandas/mixin.py 86.91% <ø> (ø)
mesa_frames/concrete/pandas/space.py 100.00% <100.00%> (ø)
mesa_frames/concrete/polars/agentset.py 86.15% <100.00%> (+0.10%) ⬆️
mesa_frames/concrete/polars/mixin.py 96.05% <ø> (ø)
mesa_frames/concrete/polars/space.py 98.75% <100.00%> (+0.03%) ⬆️
mesa_frames/utils.py 87.50% <87.50%> (ø)

@adamamer20 adamamer20 added this to the 0.1.0 Alpha Release milestone Aug 24, 2024
@adamamer20 adamamer20 merged commit c8a11fe into main Aug 24, 2024
6 checks passed
@adamamer20 adamamer20 deleted the 72-api-documentation-with-sphinx branch August 24, 2024 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Changes to CI configuration files and scripts. docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API Documentation with Sphinx
2 participants