зеркало из https://github.com/mozilla/treeherder.git
Move poetry configuration for docs to the top level (#6306)
There were some issues with the original instructions using poetry for serving the docs.
This commit is contained in:
Родитель
63646ad34e
Коммит
857d72bff1
|
@ -5,23 +5,17 @@
|
||||||
The docs are built using MkDocs, which has a live-reloading development server,
|
The docs are built using MkDocs, which has a live-reloading development server,
|
||||||
that makes working on the docs locally much easier.
|
that makes working on the docs locally much easier.
|
||||||
|
|
||||||
To use this within the Docker environment, run:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker-compose run -p 8000:8000 backend mkdocs serve -a 0.0.0.0:8000
|
|
||||||
```
|
|
||||||
|
|
||||||
Or if you would rather not use Docker, instead use poetry,run:
|
|
||||||
|
|
||||||
```console
|
```console
|
||||||
% pip install poetry
|
% pip install poetry
|
||||||
% poetry install
|
% poetry install
|
||||||
% poetry run mkdocs serve
|
% poetry run mkdocs serve
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note** - On Windows you might need to fallback ```python -m venv venv``` or ```virtualenv``` to manage your virtualenv if ```poetry``` does not work for you.
|
<!-- prettier-ignore -->
|
||||||
|
!!! note
|
||||||
|
On Windows you might need to fallback ```python -m venv venv``` or ```virtualenv``` to manage your virtualenv if ```poetry``` does not work for you.
|
||||||
|
|
||||||
In either case, the docs will then be available at: <http://localhost:8000>
|
The docs will then be available at: <http://localhost:8000>
|
||||||
|
|
||||||
## Updating package.json
|
## Updating package.json
|
||||||
|
|
||||||
|
|
|
@ -1,13 +0,0 @@
|
||||||
[tool.poetry]
|
|
||||||
name = "docs-package"
|
|
||||||
version = "1.0.0"
|
|
||||||
description = "This is the package installer for docs"
|
|
||||||
authors = ["Mozilla"]
|
|
||||||
|
|
||||||
[tool.poetry.dependencies]
|
|
||||||
python = "^3.7"
|
|
||||||
|
|
||||||
[tool.poetry.dev-dependencies]
|
|
||||||
mkdocs = "1.0.4"
|
|
||||||
mkdocs-material = "4.6.3"
|
|
||||||
mdx_truly_sane_lists = "1.2"
|
|
|
@ -1,3 +1,17 @@
|
||||||
|
[tool.poetry]
|
||||||
|
name = "docs-package"
|
||||||
|
version = "1.0.0"
|
||||||
|
description = "This is the package installer for docs"
|
||||||
|
authors = ["Mozilla"]
|
||||||
|
|
||||||
|
[tool.poetry.dependencies]
|
||||||
|
python = "^3.7"
|
||||||
|
|
||||||
|
[tool.poetry.dev-dependencies]
|
||||||
|
mkdocs = "1.0.4"
|
||||||
|
mkdocs-material = "4.6.3"
|
||||||
|
mdx_truly_sane_lists = "1.2"
|
||||||
|
|
||||||
[tool.black]
|
[tool.black]
|
||||||
line-length = 100
|
line-length = 100
|
||||||
target-version = ['py37']
|
target-version = ['py37']
|
||||||
|
|
Загрузка…
Ссылка в новой задаче