GenericMappingTools / pygmt

A Python interface for the Generic Mapping Tools.
https://www.pygmt.org
BSD 3-Clause "New" or "Revised" License
747 stars 216 forks source link

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

Closed seisman closed 3 years ago

seisman commented 3 years ago

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?

weiji14 commented 3 years ago

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 commented 3 years ago

More problems due to docutils 0.17:

image

image

maxrjones commented 3 years ago

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 commented 3 years ago

Yes to me.

maxrjones commented 3 years ago

I think we can close this now, correct?