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

[WIP] Sphinx Panels #1500

Open
wants to merge 11 commits into
base: latest
Choose a base branch
from

Conversation

josesanchez1815
Copy link

@josesanchez1815 josesanchez1815 commented May 5, 2021

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

  • which issues this PR is related to, if any ("Ref #XXX")

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!

this will allow us to use drop down boxes
Testing the sphinx panels
doc/conf.py Show resolved Hide resolved
@luizirber
Copy link
Member

A general tip: in sourmash we tend to use [WIP], [MRG] and [EXP] in the PR title, meaning that we are "working on it", "ready to merge" or "this is an experiment, I'll ask for feedback eventually". I think this is a [WIP] for now =]

@codecov
Copy link

codecov bot commented May 5, 2021

Codecov Report

Merging #1500 (5ecc2cd) into latest (d57127b) will increase coverage by 5.05%.
The diff coverage is n/a.

Impacted file tree graph

@@            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              
Flag Coverage Δ
python 94.93% <ø> (ø)
rust ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/core/src/lib.rs
src/core/src/errors.rs
src/core/src/ffi/cmd/compute.rs
src/core/src/wasm.rs
src/core/src/encodings.rs
src/core/src/ffi/hyperloglog.rs
src/core/src/from.rs
src/core/src/index/search.rs
src/core/src/sketch/hyperloglog/estimators.rs
src/core/src/index/mod.rs
... and 17 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d57127b...5ecc2cd. Read the comment docs.

@josesanchez1815 josesanchez1815 changed the title Sphinx Panels [WIP]Sphinx Panels May 5, 2021
@luizirber luizirber changed the title [WIP]Sphinx Panels [WIP] Sphinx Panels May 5, 2021
@josesanchez1815
Copy link
Author

Readthedocs says it doesn't exist but yet I find the documentation here
https://sphinx-panels.readthedocs.io/en/latest/#sphinx-configuration

@josesanchez1815
Copy link
Author

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.

Copy link
Member

@luizirber luizirber left a 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 -...

doc/conf.py Outdated Show resolved Hide resolved
setup.cfg Show resolved Hide resolved
@luizirber luizirber dismissed their stale review May 6, 2021 17:08

Issues fixed

@ctb
Copy link
Contributor

ctb commented May 8, 2021

I love where this is going, keep it up ;)

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.

None yet

3 participants