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

Pin docutils <0.17 to fix bullet lists on readthedocs #1320

Merged
merged 1 commit into from
Sep 17, 2021
Merged

Conversation

zklaus
Copy link
Contributor

@zklaus zklaus commented Sep 17, 2021

An incompatibility between the readthedocs sphinx theme and newer versions of docutils prevents proper rendering of bullet lists.
By pinning docutils <0.17 in the doc environment, we can get proper lists again.

For details see https://stackoverflow.com/a/68008428.

Description

Pins docutils <0.17.

Closes #1179

Link to documentation: https://esmvaltool--1320.org.readthedocs.build/projects/ESMValCore/en/1320/


Before you get started

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the πŸ›  Technical or πŸ§ͺ Scientific review.


To help with the number pull requests:

@zklaus zklaus added bug Something isn't working documentation Improvements or additions to documentation labels Sep 17, 2021
@codecov
Copy link

codecov bot commented Sep 17, 2021

Codecov Report

Merging #1320 (d9a9ba5) into main (723cd8f) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1320   +/-   ##
=======================================
  Coverage   86.69%   86.69%           
=======================================
  Files         188      188           
  Lines        9190     9190           
=======================================
  Hits         7967     7967           
  Misses       1223     1223           

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 723cd8f...d9a9ba5. Read the comment docs.

Copy link
Contributor

@valeriupredoi valeriupredoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cheers @zklaus 🍺

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix bullet list formatting on readthedocs
2 participants