Go to file
Ethan Paul e193bc73fe Add initial raid card setup docs 2019-11-12 16:54:43 -05:00
docs Add initial raid card setup docs 2019-11-12 16:54:43 -05:00
.gitignore Update readme and add gitignore 2019-08-27 23:25:50 -04:00
LICENSE Initial commit 2018-11-26 22:41:57 -05:00
Pipfile Add pipfile and dependencies, update project layout 2019-08-27 22:35:01 -04:00
Pipfile.lock Add pipfile and dependencies, update project layout 2019-08-27 22:35:01 -04:00
README.md Fix formatting errors in readme 2019-08-27 23:32:11 -04:00
mkdocs.yml Rename images dir to img following standard practices 2019-08-31 17:07:39 -04:00

README.md

omni-docs

ENP.One system and infrastructure documentation, written using MkDocs

building

  1. Install Pipenv
  2. Synchronize environment
  3. Build documentation
# Install pipenv
pip install pipenv --user
# Synchronize
pipenv sync
# Build docs
pipenv run mkdocs build

The docs are now located in the site/ directory and can be served as static HTML. See MkDocs deployment

editing

  1. Install Pipenv
  2. Synchronize environment, with development dependencies
  3. Run development server
# Install pipenv
pip install pipenv --user
# Synchronize, with dev deps
pipenv sync --dev
# Run dev server
pipenv run mkdocs serve

The development server is available at http://localhost:8000 and will automatically refresh with any changes made to the local files.