These are instructions for contributing to Robusta's documentation.
These docs are Sphinx docs.
Currently it's all manual docs, but at a later phase can crawl the python code, and auto generate additional docs.
GitHub actions build & deploy¶
The docs are deployed into a public gcp bucket.
Any push to docs/* will trigger a github workflow, that will build the docs to 'master' (https://docs.robusta.dev/master) Creating a code release will build and deploy docs release too. (for example: https://docs.robusta.dev/0.4.26)
If you need to override an existing doc release, you can manually trigger the workflow, with the release version as a parameter.
The docs definitions are
Learn more about
.rst files here
Prerequisites to be present on your local machine:
First install the build requirements:
poetry install -E all
To build the html and develop locally run the script:
Note: If you're on windows, run the contents of the
make help inside the
docs directory for more options for working with sphinx.