Improving These Docs¶
These docs are generated with Sphinx
Our docs are written in RST format. Learn more about RST here
Building Docs Locally¶
The following must be installed on your local machine:
Clone Robusta's repository:
git clone https://github.com/robusta-dev/robusta.git && cd robusta
Install all devlopment requirements:
poetry install -E all
Build the docs locally:
Instructions for Windows
Instead of running
./docs_autobuild.sh, copy-paste the commands inside of it and run them manually.
poetry: command not found- Make sure you have Poetry installed and run
source $HOME/.poetry/envin Linux environments to set the poetry environment variables.
sphinx-build: command not found- Make sure you have Sphinx installed.
OSError: [Errno 98] Address already in use- Use the
--port <Number>argument, with a port of your choice. Example:
./docs_autobuild.sh --port 8822
Deploying the Docs¶
These docs are automatically deployed on every commit.
On every push to
docs/*, a GitHub action builds and deploys docs to https://docs.robusta.dev/<branch-name>
On every release, a GitHub action builds and deploys docs to https://docs.robusta.dev/<version>
If you need to override an existing docs release, you can manually trigger the workflow.