open-contracting / software-development-handbook

A guide for developers of OCP's tools
https://ocp-software-handbook.readthedocs.io/en/latest/
Other
4 stars 1 forks source link

GitHub Pages replacement for ReadTheDocs #30

Closed jpmckinney closed 2 years ago

jpmckinney commented 3 years ago

We might prefer this in order to:

ReadTheDocs is also sometimes fussy and hard to debug.

Spoonbill will build its docs to GitHub Pages, so we can copy that workflow when ready.

Sphinx has a sphinx.ext.githubpages extension: https://www.sphinx-doc.org/en/master/usage/extensions/githubpages.html

jpmckinney commented 3 years ago

See also #35

jpmckinney commented 2 years ago

ReadTheDocs has been making improvements (its configuration file makes builds much more predictable) and it has many unique features (like redirects), so we will continue to use it, rather than try to re-do things on GitHub Pages.