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
[WIP] Sphinx Panels #1500
base: latest
Are you sure you want to change the base?
[WIP] Sphinx Panels #1500
Conversation
this will allow us to use drop down boxes
Testing the sphinx panels
A general tip: in sourmash we tend to use |
Codecov Report
@@ Coverage Diff @@
## latest #1500 +/- ##
==========================================
+ Coverage 89.88% 94.93% +5.05%
==========================================
Files 124 97 -27
Lines 19889 16266 -3623
Branches 1515 1515
==========================================
- Hits 17877 15442 -2435
+ Misses 1783 595 -1188
Partials 229 229
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
Readthedocs says it doesn't exist but yet I find the documentation here |
Thank you Luiz. In their documentation, under the conf.py section it says to put 'sphinx_panels'. But I will try 'sphinx-panels' instead. Thank you for pointing that out. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Annoyingly, it has different names depending on where it is added: for doc/conf.py
it uses _
, and for setup.cfg
it uses -
...
I love where this is going, keep it up ;) |
so I add an extension to include sphinx panels and enable dropdown menus to include any additional information about anything in the sphinx documentation.
This aims to solve this issue #1491
Please also be sure to note here if file formats, command-line
interface, and/or the top-level sourmash API will change because of
this PR.
No
If you are a new contributor, please provide
your ORCID. If you don't have one, please
register for one.
Once the items above are done, and all checks pass, request a review!