docs/README.md

omni-docs

ENP.One system and infrastructure documentation, using MkDocs

Building

1. Install Pipenv

   pip install pipenv --user
   

2. Synchronize environment

   pipenv sync
   

3. 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

1. Install Pipenv

   pip install pipenv --user
   

2. Synchronize environment, with development dependencies

   pipenv sync --dev
   

3. Run development server

   pipenv run mkdocs serve
   

4. Edit away!