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 visualize doc and ignore ipynb for pre-commit #655

Merged
merged 2 commits into from
May 18, 2022

Conversation

lsetiawan
Copy link
Member

This PR adds a small documentation about visualize subpackage.

@lsetiawan lsetiawan added the docs label Apr 28, 2022
@lsetiawan
Copy link
Member Author

Can someone help me in adding the create_echogram function into the api reference dropdown list in the sidebar?? I'm not sure how to do that 😞

@lsetiawan lsetiawan added the help wanted Extra attention is needed label Apr 28, 2022
@lsetiawan lsetiawan self-assigned this Apr 28, 2022
@lsetiawan lsetiawan added this to the 0.6.0 milestone Apr 28, 2022
@emiliom
Copy link
Collaborator

emiliom commented Apr 28, 2022

Can someone help me in adding the create_echogram function into the api reference dropdown list in the sidebar?? I'm not sure how to do that

I'll do this. But not right now 😢

@emiliom
Copy link
Collaborator

emiliom commented Apr 29, 2022

Can someone help me in adding the create_echogram function into the api reference dropdown list in the sidebar?? I'm not sure how to do that

Hmm, I'm realizing now that I don't know how this is behaving since the conversion to Jupyter Book. See the dynamic table of content on the upper right; that's what I would expect, except it should be exposing 3rd-level section headers but it's only exposing 2nd-level ones (I imagine this is a configuration we can change; this may be a good starting point). The dropdown on the left sidebar seems to be a selective set corresponding exclusively to automodapi-generated entities that are specified like this:

.. automodapi:: echopype.echodata
   :no-inheritance-diagram:
   :no-heading:

I don't know how Jupyter Book is deciding to grab those and create sub-headings in the left sidebar. No other page entry on the left sidebar has sub-headings.

This is a Jupyter Book problem. In the original RTD Sphinx theme, the section navigation on the left was doing exactly what I expect. See this example from v0.5.4. This will require research.

@emiliom
Copy link
Collaborator

emiliom commented Apr 29, 2022

The new "Data visualization" page has instructions for including plotting dependencies during installation with pip install: pip install echopype[plot]. How about with conda? In the Installation and Examples page, we have instructions for installation with both pip and conda, so we should have conda instructions here, too.

@lsetiawan
Copy link
Member Author

For conda, everything is included, so it already comes with the dependencies for plotting also.

@lsetiawan
Copy link
Member Author

This is a Jupyter Book problem. In the original RTD Sphinx theme, the section navigation on the left was doing exactly what I expect. See this example from v0.5.4. This will require research.

Thank you so much @emiliom for looking into this in depth! Hmm... I was hoping it would be a simple change! I'll look into further. Appreciate your help 😄

@emiliom
Copy link
Collaborator

emiliom commented May 3, 2022

This is a Jupyter Book problem. In the original RTD Sphinx theme, the section navigation on the left was doing exactly what I expect. See this example from v0.5.4. This will require research.

Thank you so much @emiliom for looking into this in depth! Hmm... I was hoping it would be a simple change! I'll look into further. Appreciate your help smile

As the next step, ideally I would suggest trying to "turn off" the drop down menu on the left sidebar and enabling 3rd-level section headers on the table of content on the right. In practice, it'll depend on how hard each of those tasks is!

@emiliom
Copy link
Collaborator

emiliom commented May 18, 2022

See #686. I give up trying to tweak the behavior of the table of contents. I'll merge this (the new visualization page), and we can revisit the table of content issue in the future.

@emiliom emiliom merged commit 099b357 into OSOceanAcoustics:dev May 18, 2022
@lsetiawan lsetiawan deleted the viz_doc branch May 19, 2022 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs help wanted Extra attention is needed
Projects
Status: Done
2 participants