Skip to content

Commit 3710709

Browse files
authored
Update CONTRIBUTING.md to add docs instructions
1 parent 3822de3 commit 3710709

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ You can run `tox` with the following arguments:
6363

6464
* `tox` to run all existing tox commands, including unit tests for all packages
6565
under multiple Python versions
66-
* `tox -e docs` to regenerate the API docs
66+
* `tox -e docs` to regenerate all docs
6767
* `tox -e py312-test-instrumentation-aiopg` to e.g. run the aiopg instrumentation unit tests under a specific
6868
Python version
6969
* `tox -e spellcheck` to run a spellcheck on all the code
@@ -89,7 +89,9 @@ for more detail on available tox commands.
8989

9090
### Troubleshooting
9191

92-
> Some packages may require additional system wide dependencies to be installed. For example, you may need to install `libpq-dev` to run the postgresql client libraries instrumentation tests. or `libsnappy-dev` to run the prometheus exporter tests. If you encounter a build error, please check the installation instructions for the package you are trying to run tests for.
92+
Some packages may require additional system-wide dependencies to be installed. For example, you may need to install `libpq-dev` to run the postgresql client libraries instrumentation tests or `libsnappy-dev` to run the prometheus exporter tests. If you encounter a build error, please check the installation instructions for the package you are trying to run tests for.
93+
94+
For `docs` building, you may need to install `mysql-client` and other required dependencies as necessary. Ensure the Python version used in your local setup matches the version used in the CI to maintain compatibility when building the documentation.
9395

9496
### Benchmarks
9597

0 commit comments

Comments
 (0)