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

Rewrite documentation in mkdocs #147

Merged
merged 45 commits into from
Mar 5, 2024
Merged

Rewrite documentation in mkdocs #147

merged 45 commits into from
Mar 5, 2024

Conversation

bdpedigo
Copy link
Collaborator

@bdpedigo bdpedigo commented Jan 30, 2024

  • removes sphinx, adds mkdocs as documentation generator
  • adds a new "client" api to the docs to more closely mirror how people interface with the package through a client object and its properties (the sub-clients)
  • adds and corrects some type hints (but didn't attempt to catch everything)

@bdpedigo
Copy link
Collaborator Author

preview of what this would look like: https://bdpedigo.github.io/CAVEclient/

@bdpedigo
Copy link
Collaborator Author

I think this is good to go except for changing github paths etc. in mkdocs.yml. will wait to do that until any other feedback is done

@fcollman fcollman merged commit 2afe64a into CAVEconnectome:master Mar 5, 2024
15 checks passed
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.

2 participants