Add information on how to interpret output graphs?

[josesanchez1815]

I think it would be helpful to include in the sourmash documentation on how to interpret the charts and graphs that sourmash produces.

I may suggest

• adding information in a side text
• captions that describe the x and y axis of the genome matrix
• Dropdown boxes in cases users would like to know more about the graph.

The graphs and chart in reference can be found here: genome matrix

or see image below.

[ctb]

hi @josesanchez1815 I think the main thing I need help with is how to support "reveals", so we can add text that is only shown when someone wants to see it. I cannot find anything on how to do this with sphinx plugins but I suspect I am not using the right google search terms!

FWIW, all the doc stuff is under doc/ and we use sphinx and myst-parser. There are a variety of sphinx themes out there, too.

I can supply draft text describing diagrams but I don't know how to put it on the web site properly, basically!

[josesanchez1815]

Hello! How would I be able to preview the changes I make to a branch?

To start off: I forked the sourmash repository to my own github, so I don't worry about breaking anything.

Then I want to be able to see the changes I've made to my repository. I would try to use read the docs but I get an error message.

[luizirber]

This might be happening because you don't have readthedocs working properly for your fork. I would suggest opening a PR against dib-lab/sourmash and use the PR preview feature from readthedocs. You can see an example in https://github.com/dib-lab/sourmash/pull/1499, one of the checks (at the bottom of the page) has a link to the rendered docs:

[luizirber]

and you can also build the docs locally with tox -e docs it gives you a path to open the generated docs at the end, something like documentation available under file:///home/user/sourmash/.tox/docs_out/index.html