blob: cbef50e07270c3985d540c7b5c34feb3808c9ebf (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
|
# Project Documentation
This directory contains the mkdocs configuration and markdown files for the
PyDis DevOps documentation.
To work on these files, install the docs dependencies with `poetry install
--with docs` in the root folder.
You can work locally on the site by navigating to the root directory and running
`poetry run task serve-docs` which will start a local server with live
reloading. You can also run `poetry run task build-docs` in the root to build a
local copy of the documentation, which will be placed in the `docs/site` folder
(`site` folder of this directory).
|
