Consider moving to sphinx-contrib and appointing a second maintainer #88
Comments
1 task
|
Also a bit worried about maintenance of this great project. Hopefully this sorts out ❤️ |
|
Since this projects seems to be unmaintained, I started developing sphinx-polyversion (which is such an original name, if you have a better idea pls tell me). The tool probably |
problame
added a commit
to zrepl/zrepl
that referenced
this issue
Sep 8, 2023
The sphinxcontrib-versioning seems unmaintainted and I can't get the fork that we used before this PR working on Python 3.10. The situation wrt maintenance doesn't seem much better for sphinx-multiversion, but, at least I could get it to work with current sphinx versions. The main drawback of this PR is that we're breaking the default URLs. I.e., `https://zrepl.github.io/configuration.html` will be 404. And since we're on GitHub pages and don't control the webserver, we can't install a redirect easily. The above is not necessarily a show-stopper, but not great either. So, not merging this PR right away but looking into `sphinx-polyversion` as recommended in Holzhaus/sphinx-multiversion#88 (comment) Notes ===== The `requirements.txt` in this PR is from a clean Python 3.10 venv on Ubuntu 22.10 after ``` pip install sphinx sphinx-rtd-theme sphinx-multiversion ```
problame
added a commit
to zrepl/zrepl
that referenced
this issue
Sep 9, 2023
The sphinxcontrib-versioning seems unmaintainted and I can't get the fork that we used before this PR working on Python 3.10. The situation wrt maintenance doesn't seem much better for sphinx-multiversion, but, at least I could get it to work with current sphinx versions. The main problem with sphinx-multiversion is that it doesn't render anything at `/`. I.e., `https://zrepl.github.io/configuration.html` will be 404. That's different from `sphinxcontrib-versioning`, and thus switching to sphinx-multiversion would break URLs. We host on GitHub pages and don't control the webserver, so, we can't use webserver-level redirects to keep the URLs working. We could create JS-level redirects, or `http-equiv`, but that's ugly as well. The simplest solution was to fork sphinx-multiversion and hard-code zrepl's specific needs into that fork. The fork is based off v0.2.4 and pinned via requirements.txt. Here are its unique commits: Holzhaus/sphinx-multiversion@master...zrepl:sphinx-multiversion:zrepl We should revisit `sphinx-polyversion` in the future once its docs improve. See Holzhaus/sphinx-multiversion#88 (comment) This PR updates the various Python packages, as I couldn't get sphinx-multiversion to work with the (very old) versions that were pinned in `requirements.txt` prior to this PR. This PR's `requirements.txt` is from a clean Python 3.10 venv on Ubuntu 22.10 after running ``` pip install sphinx sphinx-rtd-theme pip install 'git+https://github.com/zrepl/sphinx-multiversion/@52c915d7ad898d9641ec48c8bbccb7d4f079db93#egg=sphinx_multiversion' ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
@Holzhaus it seems like you are currently occupied with other projects and while that's perfectly fine, it would be unfortunate if this awesome sphinx extension would be strangled by it.
Therefore I propose to appoint one or two willing past contributors as maintainers and to move the repository to the sphinx-contrib organization. What is your opinion on this?
The text was updated successfully, but these errors were encountered: