Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Continuous integration: sphinx-versioning is obsolete #1157

Closed
vuilleumierc opened this issue Apr 19, 2021 · 2 comments
Closed

Continuous integration: sphinx-versioning is obsolete #1157

vuilleumierc opened this issue Apr 19, 2021 · 2 comments

Comments

@vuilleumierc
Copy link
Member

We currently use sphinx-versioning to create the documentation for the different versions of pyramid_oereb as part of the CI. This package is not maintained anymore and works only with older versions of Sphinx (see e.g. this issue), so it would be nice to find an alternative.

@vuilleumierc
Copy link
Member Author

Unfortunately there does not seem to be a good alternative to sphinx-versioning (see e.g. the discussion here).

Currently, we use Sphinx to build the documentation, sphinx-versioning to create a multi-version documentation, and GitHub pages for the hosting. If we wanted to keep the documentation in multiple versions, it seems we should either migrate from Sphinx (to something like MKDocs) which requires some work (the input .rst files have to be adapted) or find another hosting solution than GitHub (like Read The Docs, which is not entirely free (advertisement or subscription), plus it would probably be a good thing to keep the project entirely at the same place, that is GitHub).

So for the moment I will remove sphinx-versioning from the CI, so that we can keep Sphinx up-to-date, but it means the documentation will only be available for the master branch. Any suggestions are of course welcome

@vuilleumierc
Copy link
Member Author

The URL for the documentation is now https://openoereb.github.io/pyramid_oereb/

@jwkaltz jwkaltz closed this as completed May 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants