Use simple doc server to deploy DORiE docs
Utopia uses a simple Doc server instance for deploying its documentation. The instance runs on our Hermes server. As indicated in #143 (closed), our current hosting situation on Netlify has several shortcomings. Most notably, we cannot deploy multiple versions of the documentation. ReadTheDocs, on the other hand, only allows building the documentation itself, which means that it cannot include files that are configured by CMake. Both are issues we can remedy by using our own server.
Upload the Doxygen and the Sphinx documentation to our own doc server.
doc_serverto be able to serve an arbitrary repository: utopia/doc_server#2
- Include an instance of the doc server into the Hermes server setup: infrastructure/gitlab_setup#22
- Add/update Project Badges
- Add private SSH key
Add public SSH key to
authorized_keysof doc server container
One interesting addition to the deploy routine in Utopia would be to deploy docs for MRs as well, such that docs can be directly reviewed online before merging.
How to test the implementation?
Pipeline succeeds and deploys documentation to doc server.
See #143 (closed)