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.

Sign up for GitHub

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

Jump to bottom

API Documentation with Sphinx #75

Merged
merged 59 commits into from
Aug 24, 2024
Merged

API Documentation with Sphinx #75

merged 59 commits into from
Aug 24, 2024

Commits on Aug 21, 2024

  1. adding pydocstyle to pyproject.toml

    @adamamer20
    adamamer20 committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    f2aca2e View commit details
    Browse the repository at this point in the history

  2. adding mesa_frames __init__ docstring

    @adamamer20
    adamamer20 committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    a1bbebd View commit details
    Browse the repository at this point in the history

  3. adding mesa_frames/abstract __init__ docstring

    @adamamer20
    adamamer20 committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    85c702d View commit details
    Browse the repository at this point in the history

  4. fixing mesa_frames/abstract/agents.py for ruff.pydocstyle

    @adamamer20
    adamamer20 committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    45b1dfd View commit details
    Browse the repository at this point in the history

  5. fixing mesa_frames/abstract/mixin.py for ruff.pydocstyle

    @adamamer20
    adamamer20 committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    91ee44b View commit details
    Browse the repository at this point in the history

  6. fixing mesa_frames/abstract/space.py for ruff.pydocstyle

    @adamamer20
    adamamer20 committed Aug 21, 2024
    Configuration menu
    Copy the full SHA
    aff9b52 View commit details
    Browse the repository at this point in the history

Commits on Aug 22, 2024

  1. adding __init__ to mesa_frames/concrete

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    c6c8896 View commit details
    Browse the repository at this point in the history

  2. fixing arguments in __init__ of the module

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    ccf02fc View commit details
    Browse the repository at this point in the history

  3. fixing mesa_frames/concrete/model.py for ruff.pydocstyle

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    31e5d67 View commit details
    Browse the repository at this point in the history

  4. fixing mesa_frames/concrete/agents.py for ruff.pydocstyle

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    14d2482 View commit details
    Browse the repository at this point in the history

  5. fixing mesa_frames/concrete/pandas/agentset.py for ruff.pydocstyle

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    43770d6 View commit details
    Browse the repository at this point in the history

  6. adding __init__ to mesa_frames/concrete/pandas

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    55c6f91 View commit details
    Browse the repository at this point in the history

  7. fixing mesa_frames/concrete/pandas/mixin.py for ruff.pydocstyle

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    b1850f5 View commit details
    Browse the repository at this point in the history

  8. removing methods section (hard to mantain, and automatically generate… 

    …d by sphinx)
    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    923caf3 View commit details
    Browse the repository at this point in the history

  9. removing properties (sphinx will generate that)

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    6c8af78 View commit details
    Browse the repository at this point in the history

  10. moving parameters to __init__

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    3455d5d View commit details
    Browse the repository at this point in the history

  11. fixing mesa_frames/concrete/pandas/space.py

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    3834e67 View commit details
    Browse the repository at this point in the history

  12. adding __init__ to mesa_frames/concrete/polars

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    3f41bf2 View commit details
    Browse the repository at this point in the history

  13. removing docstring (sphinx will autogenerate from AgentSetDF)

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    92e3dad View commit details
    Browse the repository at this point in the history

  14. removing docstring (sphinx will autogenerate from GridDF)

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    ae3cd15 View commit details
    Browse the repository at this point in the history

  15. removing docstring (sphinx will autogenerate from DFMixin)

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    e904e01 View commit details
    Browse the repository at this point in the history

  16. deactivate D101 and D102 (too many errors due to inheritance)

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    283a996 View commit details
    Browse the repository at this point in the history

  17. deactivating d105 (doesn't work well with inheritance)

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    d135d62 View commit details
    Browse the repository at this point in the history

  18. fixing mesa_frames/concrete/polars/agentset.py for ruff.pydocstyle

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    09ca47f View commit details
    Browse the repository at this point in the history

  19. fixing mesa_frames/concrete/polars/mixin.py for ruff.pydocstyle

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    1e32f46 View commit details
    Browse the repository at this point in the history

  20. fixing mesa_frames/concrete/polars/space.py

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    ebfa347 View commit details
    Browse the repository at this point in the history

  21. ignoring in tests, examples or docs

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    d1b2acf View commit details
    Browse the repository at this point in the history

  22. test -> tests

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    e5af36b View commit details
    Browse the repository at this point in the history

  23. adding __init__ to type aliases

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    d057c39 View commit details
    Browse the repository at this point in the history

  24. removing commented test

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    ce8aaf1 View commit details
    Browse the repository at this point in the history

  25. test fix

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    cf9cbe1 View commit details
    Browse the repository at this point in the history

  26. adding sphinx dependencies

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    f082224 View commit details
    Browse the repository at this point in the history

  27. quick starting sphinx

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    6e4ee83 View commit details
    Browse the repository at this point in the history

  28. updating dependencies for docs

    @adamamer20
    adamamer20 committed Aug 22, 2024
    Configuration menu
    Copy the full SHA
    8d1c100 View commit details
    Browse the repository at this point in the history

Commits on Aug 24, 2024

  1. adding required dependencies

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    d4c5094 View commit details
    Browse the repository at this point in the history

  2. configuring api documentation

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    51f4b38 View commit details
    Browse the repository at this point in the history

  3. creating docs structure

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    9453a37 View commit details
    Browse the repository at this point in the history

  4. copying description from parent class for abstract classes

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    4e1d0a8 View commit details
    Browse the repository at this point in the history

  5. renaming docs action to mkdocs

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    ac8a74b View commit details
    Browse the repository at this point in the history

  6. changing requirements to mkdocs_requirements.txt

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    55dbb89 View commit details
    Browse the repository at this point in the history

  7. moving mkdocs to docs/general

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    4b1ee16 View commit details
    Browse the repository at this point in the history

  8. unique gh action for deployment

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    1401ad3 View commit details
    Browse the repository at this point in the history

  9. adding sphinx files to docs/api

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    53bbede View commit details
    Browse the repository at this point in the history

  10. fix: checkout = false (checked out before)

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    fae5822 View commit details
    Browse the repository at this point in the history

  11. fix: unique gh pages actions

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    22d2c2f View commit details
    Browse the repository at this point in the history

  12. fix: removed api from docs

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    d63902b View commit details
    Browse the repository at this point in the history

  13. rename for clarity

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    f8945d6 View commit details
    Browse the repository at this point in the history

  14. removed redundant/useless requirements

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    58ebd14 View commit details
    Browse the repository at this point in the history

  15. moving to /reference for clarity (similar to polars)

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    9d6d450 View commit details
    Browse the repository at this point in the history

  16. fix: update reqs

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    dba7fd8 View commit details
    Browse the repository at this point in the history

  17. adding section headers

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    fa1b20d View commit details
    Browse the repository at this point in the history

  18. removing properties (automatically generated by sphinx)

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    61c9efa View commit details
    Browse the repository at this point in the history

  19. Revert "adding section headers" 

    This reverts commit fa1b20d.
    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    1fbbe6a View commit details
    Browse the repository at this point in the history

  20. adding title

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    e4dd017 View commit details
    Browse the repository at this point in the history

  21. adding description for backend specific classes (better for sphinx)

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    2dae685 View commit details
    Browse the repository at this point in the history

  22. Merge branch 'main' of https://github.com/adamamer20/mesa-frames into… 

    … 72-api-documentation-with-sphinx
    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    f380206 View commit details
    Browse the repository at this point in the history

  23. run only 72-api-documentation-with-sphinx

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    3b8f89a View commit details
    Browse the repository at this point in the history

  24. Merge branch 'main' into 72-api-documentation-with-sphinx

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    0a8f864 View commit details
    Browse the repository at this point in the history

  25. changing branch to main

    @adamamer20
    adamamer20 committed Aug 24, 2024
    Configuration menu
    Copy the full SHA
    8724b20 View commit details
    Browse the repository at this point in the history