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

Wrong style of toctree caption due to breaking changes in docutils 0.17 #1176

Closed
seisman opened this issue Apr 5, 2021 · 5 comments
Closed
Labels
documentation Improvements or additions to documentation maintenance Boring but important stuff for the core devs
Milestone

Comments

@seisman
Copy link
Member

seisman commented Apr 5, 2021

Description of the problem

Go to https://www.pygmt.org/dev/, you will see:

image

The toctree captions don't show correctly, dut to breaking changes in docutils 0.17.

See related bug reports and possible fixes:

I think we need to pin docutils to 0.16 as a workaround, and wait for upstream fixes. Agree?

@seisman seisman added documentation Improvements or additions to documentation maintenance Boring but important stuff for the core devs labels Apr 5, 2021
@weiji14
Copy link
Member

weiji14 commented Apr 5, 2021

I think we need to pin docutils to 0.16 as a workaround, and wait for upstream fixes. Agree?

Since this only affects the dev doc page, I would wait for 24-48 hours to see if docutils does a bugfix release that would resolve things automatically.

@seisman
Copy link
Member Author

seisman commented Apr 5, 2021

More problems due to docutils 0.17:

image

image

@maxrjones
Copy link
Member

All the lists are messed up as well: https://www.pygmt.org/dev/changes.html. Since there are so many problems, I think pinning to a prior version is appropriate rather than waiting.

@seisman
Copy link
Member Author

seisman commented Apr 5, 2021

Yes to me.

@maxrjones
Copy link
Member

I think we can close this now, correct?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Boring but important stuff for the core devs
Projects
None yet
Development

No branches or pull requests

3 participants