Qcodes icon indicating copy to clipboard operation
Qcodes copied to clipboard

Docs: use furo theme

Open astafan8 opened this issue 3 years ago • 10 comments

https://github.com/pradyunsg/furo

astafan8 avatar Jul 14 '22 11:07 astafan8

Codecov Report

Merging #4395 (7f82dc9) into master (aea5c1a) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4395   +/-   ##
=======================================
  Coverage   68.36%   68.36%           
=======================================
  Files         276      276           
  Lines       31024    31024           
=======================================
  Hits        21210    21210           
  Misses       9814     9814           

codecov[bot] avatar Jul 14 '22 11:07 codecov[bot]

looks good , but we need to do some customizations so that more than one level of sub titles and sub pages is properly rendered, ie not as a flat list, see here: image

astafan8 avatar Jul 14 '22 12:07 astafan8

Looks really clean, definitely an upgrade.

trevormorgan avatar Jul 14 '22 22:07 trevormorgan

@astafan8 I took the liberty of rebasing this on top of master with #4434

jenshnielsen avatar Jul 29 '22 08:07 jenshnielsen

Hmn not sure what happens here?

ERROR: Cannot install qcodes[docs]==0.0 because these package versions have conflicting dependencies.

The conflict is caused by:
    qcodes[docs] 0.0 depends on furo>=2022.06.21; extra == "docs"
    The user requested (constraint) furo~=2022.06.21

To fix this you could try to:
ERROR: ResolutionImpossible: for help visit https://pip.pypa.io/en/latest/topics/dependency-resolution/#dealing-with-dependency-conflicts
1. loosen the range of package versions you've specified
2. remove package versions to allow pip attempt to solve the dependency conflict

jenshnielsen avatar Jul 29 '22 08:07 jenshnielsen

Seems like this is caused by using ~= with the non conformant version number 2020.06.21

jenshnielsen avatar Jul 29 '22 08:07 jenshnielsen

@astafan8 I think it would be nice to land this PR, would you be okay if I took it over and tried to finish it up?

trevormorgan avatar Sep 20 '22 04:09 trevormorgan

@trevormorgan I think that would be great. @astafan8 and I talked about landing https://github.com/QCoDeS/Qcodes/issues/4457 first since that would significantly reduce the number of nested tabels in the toc. If you want to research if there is a way to get multiple layers in the toc to render correctly that would IMHO be great

jenshnielsen avatar Sep 20 '22 09:09 jenshnielsen

@trevormorgan sure, any help is appreciated :)

and indeed, as Jens said, it does make sense to finish the instrument driver api part first, which will help reduce the levels , which in turn should make our docs structure work better with furo.

However, another thing we could do is to find another more modern theme that does not prescribe limits on the nesting levels in the docs, e.g. matplotlib/numpy/pandas perhaps are worthy examples to look at (i havent' done that yet).

astafan8 avatar Sep 20 '22 11:09 astafan8

Sounds good @jenshnielsen and @astafan8. I'll help out on #4457 first before jumping on this PR.

trevormorgan avatar Sep 21 '22 02:09 trevormorgan

closing as furo might not be the best theme to use, see above in the comments

astafan8 avatar Nov 16 '22 09:11 astafan8