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

WIP: Resolve docstring errors and transition to MkDocs #35

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

MitchellAcoustics
Copy link
Collaborator

Transitioning to mkdocs for documentation.

At current stage 7d116d0, the mkdocs is configured, and some pages and docstrings have been converted.

Ongoing work is to continue converting docstrings, then integrate jupyter notebooks, then reexamine the layout and organisation of the docs

@MitchellAcoustics MitchellAcoustics added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Nov 1, 2024
@MitchellAcoustics MitchellAcoustics self-assigned this Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
1 participant