Ethan Paul bb15a5a222 | ||
---|---|---|
docs | ||
.gitignore | ||
LICENSE | ||
Pipfile | ||
Pipfile.lock | ||
README.md | ||
mkdocs.yml |
README.md
omni-docs
ENP.One system and infrastructure documentation, using MkDocs
Building
-
Install Pipenv
pip install pipenv --user
-
Synchronize environment
pipenv sync
-
Build documentation
pipenv run mkdocs build
Built docs are now located in site/
and can be served as static HTML. See MkDocs deployment
Editing/Developing
-
Install Pipenv
pip install pipenv --user
-
Synchronize environment, with development dependencies
pipenv sync --dev
-
Run development server
pipenv run mkdocs serve
-
Edit away!