Docs not deploying? #1794
Comments
Byron
added a commit
that referenced
this issue
Jan 10, 2024
It seems they now require a configuration file.
Byron
added a commit
that referenced
this issue
Jan 10, 2024
It seems they now require a configuration file. Also the theme configuration changed. It's nice they were stable for more than 10 years though.
|
Thanks for letting me know! It looks like it stopped working 3 months ago, probably due to changes in readthedocs itself. I was able to cobble a fix together which includes yet another yaml file. It looks quite different too as the theme isn't supported anymore either, but I guess a wallpaper change was in order after more than 13 years or so 😁. If you have any experience with theming (the new) sphinx, contributions for improvements are definitely welcome. Please also note that I can't fix tags, but the next release should happen soon enough. |
EliahKagan
added a commit
to EliahKagan/GitPython
that referenced
this issue
Feb 23, 2024
This configures Read the Docs builds to be more like local builds in two ways: - Pass "-W", as is done in a local build with "make -C doc html", so that if there are broken references, the build fails. - Install dependencies. This configures the Python environment, via the python.install key, so that RTD builds install requirements. More specifically on dependency installation, it does two things: 1. The equivalent of "pip install .", which installs the project and its dependencies (though not any extras). This includes the gitdb dependency, which is needed to import GitPython's git module to populate sections in the API Reference page (gitpython-developers#1840). 2. The equivalent of "pip install -r doc/requirements.txt", which installs the additional Sphinx-related dependencies used when building documentation locally. Installing Sphinx-related dependencies is useful for three reasons: a. Least importantly, it should increase consistency between remote (RTD) and local documentation builds. b. It may be needed to avoid warnings that are not being fixed at this time, while still allowing the build to succeed with the "-W" option (see above on that change) that causes failure for immediately addressable problems. The effect of newer versions of Sphinx carrying a few extra hard-to-fix warnings for GitPython is noted in gitpython-developers#1802 (and is why they are not upgraded in gitpython-developers#1803). c. One of the documentation build dependencies listed in doc/requirements.txt is sphinx_rtd_theme. In 634151a (for gitpython-developers#1794) the line specifying this theme was commented out, since it apparently broke in the build. This may allow it to be used again (or can be replaced with another custom theme if desired). This also reenables the sphinx_rtd_theme theme disabled in 634151a. Finally, this makes minor changes to .readthedocs.yml's comments and formatting so the comments are accurate for GitPython details and so the file is formatted in the same style as other YAML here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
On PyPI this project has releases for 3.1.37 through 3.1.41, with the latter being the most recent at the time of writing. In contrast the docs only list up to 3.1.37 in the changelog.
The source for the changelog on
maindoes seem to contain entries for those missing releases, so maybe this is just that the docs aren't deployed or something?The text was updated successfully, but these errors were encountered: