Skip to content

Commit

Permalink
chore: updated docs to include mention of --no-root option for poetry
Browse files Browse the repository at this point in the history
Since Poetry is being used here solely to build mkdocs, if the --no-root
option is omitted when installing, Poetry will emit a ValueError.
See this Issue: python-poetry/poetry#2458 (comment)

Signed-off-by: Stephan Garland <stephan.garland@zapier.com>
  • Loading branch information
stephanGarland committed Jan 31, 2023
1 parent f06dca3 commit 0456e9e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,5 +124,5 @@ testSuite.InitTestSuite()

### Documentation Changes

We use [mkdocs](https://www.mkdocs.org/) to build our docs locally. Ensure that you have `poetry` installed and run `poetry install` in the root of the repo. Once it pulls all of the required dependencies you can run `poetry run mkdocs serve` to launch a local server that will serve `docs/`. It will also auto reload when any file is changed in that directory. By default you can view the docs under `http://localhost:8000`. Please confirm that any changes to documentation render correctly and that your changes display as expected.
We use [mkdocs](https://www.mkdocs.org/) to build our docs locally. Ensure that you have `poetry` installed, then run `poetry install --no-root` in the root of the repo. Once it pulls all of the required dependencies you can run `poetry run mkdocs serve` to launch a local server that will serve `docs/`. It will also auto reload when any file is changed in that directory. By default you can view the docs under `http://localhost:8000`. Please confirm that any changes to documentation render correctly and that your changes display as expected.

0 comments on commit 0456e9e

Please sign in to comment.