-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Closed
Labels
DocumentationRelease criticalFor bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.status: upstream fix required
Milestone
Description
Bug report
I've just build the matplotlib docs with sphinx master (future 2.0) and some of the styling has gone bad:
Edit: Let's collect all the doc rendering problems in this issue, so that we know what we have to fix later on:
List of issues:
- Numpydoc parameters section title rendered incorrectly (see below in this comment, @dstansby: fixed in sphinx 2.1.2)
- No space between parameter names and types in numpydoc parameters sections (see below in this comment, upstream bug: Sphinx 2.0 compatibility issue? numpy/numpydoc#215, , fix in Fix API contents display for sphinx 2 #14105).
- Some headlines broken (Style issues when building the docs with (future) Sphinx 2.0 #13591 (comment), fixed in sphinx 2.1)
- Wrapping after bullet points in table of contents (Style issues when building the docs with (future) Sphinx 2.0 #13591 (comment), fix in Fix API contents display for sphinx 2 #14105)
- Table rendering (Style issues when building the docs with (future) Sphinx 2.0 #13591 (comment))
- Rendering of list of methods (Style issues when building the docs with (future) Sphinx 2.0 #13591 (comment))
- Search is broken (Style issues when building the docs with (future) Sphinx 2.0 #13591 (comment), fixed in sphinx 2.0.1)
Issue: Numpydoc parameters section
[ ] Need to check if there will style changes in sphinx 2.0 and possibly adapt mpl.css.
Metadata
Metadata
Assignees
Labels
DocumentationRelease criticalFor bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.status: upstream fix required