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

Doc update: installation instruction and API reference #255

Merged
merged 4 commits into from
May 9, 2022
Merged

Conversation

abey79
Copy link
Owner

@abey79 abey79 commented May 9, 2022

Description

  • Updated the installation instructions in the documentation and README.md
  • Complete overhaul of the API reference
    • Migrated to sphinx-autoapi
    • Custom templates, including custom autosummary-style macro
    • Fixed/improved docstrings

Fixes #250

Checklist

  • feature/fix implemented
  • mypy returns no error
  • tests added/updated and pytest --runslow succeeds
  • documentation added/updated and building with no error (make clean && make html in docs/)
  • examples added/updated
  • code formatting ok (black and isort)

abey79 added 4 commits May 7, 2022 16:54
- removed support for colab (environment.py)
- `display()` now support only matlab (mode removed)
- migrated to modern typing annotations
- migrated to autoapi
- custom auto_summary() macro
- customized autoapi templates
@abey79 abey79 merged commit 0549d7d into master May 9, 2022
@abey79 abey79 deleted the doc-update branch May 9, 2022 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README.md has older, pip-based install instructions
1 participant