skylab/docs

Go to file

Ethan Paul bb15a5a222 Update readme and add gitignore		2019-08-27 23:25:50 -04:00
docs	Rewrite mainpage to include updated documentation	2019-08-27 23:02:35 -04: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
mkdocs.yml	Rewrite mainpage to include updated documentation	2019-08-27 23:02:35 -04: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	Update readme and add gitignore	2019-08-27 23:25:50 -04:00

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!