search

boostorg / python

Boost.org python module
http://boostorg.github.io/python
Boost Software License 1.0
465 stars 201 forks source link

Support newer version of Sphinx #398

Open sdarwin opened 1 year ago

sdarwin commented 1 year ago

Hi, The current boostorg/boost bundle has been created using Sphinx version 1.5.6

If upgrading all packages and Sphinx changes to 5.2.1, the numpy docs are slightly broken.

Researched the problems in https://github.com/sphinx-doc/sphinx/issues . After some experimentation it looks like the fix in this pull request solves the issues.

sdarwin commented 1 year ago

I tested these changes, and they worked for Sphinx 1.5.6 and 5.2.1. An easy way to verify is to merge this into the develop branch. New docs will appears at https://www.boost.org/doc/libs/develop/libs/python/doc/html/index.html . If there are any problems it could be rolled back and not merged into the master branch.

Only a small number of boost libraries have any issues, such as this one. Most do not use Sphinx. After this update, it will open the door to upgrade the entire set of packages for all boost docs.

sdarwin commented 1 year ago

Sphinx 5.2.1 has been deployed in the boost develop branch. Not yet in the master branch. Example: https://www.boost.org/doc/libs/develop/libs/python/doc/html/numpy/reference/dtype.html