Skip to content

Add missing analysis docs to Sphinx doc tree#98

Merged
lgarrison merged 7 commits intomainfrom
analysis-doc-fix
Jul 6, 2023
Merged

Add missing analysis docs to Sphinx doc tree#98
lgarrison merged 7 commits intomainfrom
analysis-doc-fix

Conversation

@lgarrison
Copy link
Member

No description provided.

@lgarrison lgarrison requested a review from boryanah July 5, 2023 16:23
@lgarrison
Copy link
Member Author

@boryanah The tutorial notebooks and ZCV API should render in the docs now. Can you check that everything looks as expected? The rendered docs are linked from the readthedocs GitHub check.

I also tried to clean up the power spectrum docs a little bit by defining __all__ as the list of functions that users might want to use (i.e. a public API). Only those functions render in the API docs; I think that's more useful than a full dump of all functions, but I'm happy to discuss this. We might want to do something similar for the ZCV module at some point.

@boryanah
Copy link
Collaborator

boryanah commented Jul 6, 2023

Looks great to me! Thanks a lot! I agree with having only the __all__ functions show up and perhaps we should do the same for ZCV later on.

If I want to make changes to the ZCV jupyter notebook at some later point, can I just directly edit the ipynb file or do I need to do something else so it renders in the RTD?

@lgarrison
Copy link
Member Author

You should be able to edit the ipynb file directly, and it will automatically be built into a Sphinx page and render on RTD (the magic is the MyST-NB Sphinx extension!). You can also make sections using Markdown headers (##, ###, etc), and they'll render in the Contents menu on the right (the TSC and CompaSO subsample notebooks use this, for example).

@lgarrison lgarrison merged commit 51347f5 into main Jul 6, 2023
@lgarrison lgarrison deleted the analysis-doc-fix branch July 6, 2023 00:43
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