qgis / pyqgis-api-docs-builder

Sphinx project to build python API documentation for QGIS
https://qgis.org/pyqgis/master/
GNU General Public License v2.0
86 stars 31 forks source link

Fix appearance of class docstrings, constructor methods, ... #167

Closed nyalldawson closed 2 months ago

nyalldawson commented 2 months ago

This PR results in a lot of improvements :smile:

It's directed at fixing this:

image

Where:

  1. The constructors just get dumped as part of the class description, making the text confusing to read
  2. The way the constructors just appear as plain text, not functions

Now:

Class description shows at the top of the page:

image

While constructors are nicely documented + formatted before the other methods:

image

It also fixes this issue, where the notes block format leaks into the table of contents:

image

Now it's correctly formatted:

image