Closed victorlin closed 2 years ago
👍 I'll spend some time making sure things look fine locally first.
I've actually been using sphinx_rtd_theme=1.0.0
for a while now – it was the resolved version when I created my dev environment in November. So this PR is mainly for the RTD build server which has sphinx_rtd_theme=0.4.3 pre-installed: https://github.com/nextstrain/ncov/issues/891#issuecomment-1071156994
Throughout my usage and clicking around some more just now, nothing breaks but there's just some very minor whitespace differences and most notably a difference in styling for certain lists like:
- ``nextstrain build .``
- ...
- ``--cores 4``
- ...
- ``--configfile ncov-tutorial/example-data.yaml``
- ...
See differences [src]:
0.4.3 | 1.0.0 |
---|---|
I don't mind the differences, I think good to merge/release to fix the list styling in our RTD-built docs.
Sounds good to me.
Description of proposed changes
Starting with docutils 0.17, div.section has been replaced with section among other changes. This hasn't been a problem until recently when dependency resolution resolved to docutils 0.17, causing unwanted differences in CSS selector behavior using an older version of sphinx_rtd_theme [1].
sphinx_rtd_theme=1.0.0 is the first version to support docutils 0.17 [2].
Related issue(s)
Testing
No testing