How to edit this Documentation

Edit locally

Requirements

• Python >= 3.9

• Poetry >= 2.1

Preparations

1. Clone Repository:

git clone https://github.com/exasol/developer-documentation.git

2. Create Branch:

git switch -C documentation/my_awesome_branch

3. Create Poetry Environment:

poetry install

Edit documentation

1. Edit documentation in doc directory using Sphinx reStructuredText

2. Build the documentation locally:

poetry run nox -s docs:build

3. Open the locally built documentation in your browser:

poetry run nox -s docs:open

4. When finished editing

git commit -m "My awesome change"
git push origin documentation/my_awesome_branch

And finally create a PR on GitHub.

Edit in GitHub Codespaces

Preparations

1. Start a Codespace on GitHub

2. Wait for Codespace to start (can take a few minutes)

3. Select the Terminal in Codespace, if not already selected

4. Wait for the installation of poetry

5. Create branch:

git switch -C documentation/my_awesome_branch

6. Create poetry environment:

poetry install

Edit documentation

4. Edit Documentation in doc directory using Sphinx reStructuredText

5. Build the Documentation:

poetry run nox -s docs:build

6. Serve the Documentation:

poetry run nox -s docs:serve &> /dev/null &

6. Forward port on Codespace and open the served Documentation:

7. When finished editing

git commit -m "My awesome change"
git push origin documentation/my_awesome_branch

And finally create a PR on GitHub.

Stopping or deleting a Codespace

Codespace can cause costs, so stopping or deleting them after use is a good idea.

1. Go to the Codespace page

2. Stop or delete a Codespace