Join GitHub today
fail to build the documentation in 12.2 #354
Originally reported by: Anonymous
not sure if this really is a sphinx issue ...
It's not a sphinx issue. It's an issue with the script that adds links to the changelog. It assumes that the docs are built from the root of the repository and not from 'docs/'.
The fix is not obvious to me. It seems the sphinx-built command (and other systems like read the docs) are pretty opinionated about the command being run from the 'docs' directory. However, the 'setup.py build_sphinx' script is typically invoked from the root of the repository. I'm not sure how to readily and elegantly accommodate both modes.
To make matters worse, the latest, unreleased code no longer uses the linkify script, but instead relies on a third-party library. This means that doc builds will require prerequisite libraries to be installed before building the docs.
Therefore, I recommend instead using the setuptools command to build docs. Simply:
That will download any requisite libraries and build the docs in the build/sphinx directory. Will that work for your purposes?