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

Add autogenerated docs #18

Merged
merged 13 commits into from
Oct 11, 2024
Merged

Add autogenerated docs #18

merged 13 commits into from
Oct 11, 2024

Conversation

kushaangupta
Copy link
Collaborator

Closes #9

@kushaangupta kushaangupta marked this pull request as draft September 14, 2024 05:17
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@kushaangupta
Copy link
Collaborator Author

kushaangupta commented Oct 1, 2024

@ryanharvey1 It seemed impossible to make the docs generation work without putting stuff in src. Turns out it has an added bonus: https://ccn-template.readthedocs.io/en/latest/notes/01-structure/

We still need to figure out how to only show the documentation of the functions exposed for user using pyi files. But this still looks good to merge

@kushaangupta kushaangupta marked this pull request as ready for review October 1, 2024 13:51
@ryanharvey1 ryanharvey1 merged commit 59c4aa7 into main Oct 11, 2024
7 checks passed
@kushaangupta kushaangupta deleted the add-docs branch October 11, 2024 18:16
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.

Add docs page
2 participants