deqar-docs

MkDocs documentation of DEQAR

Installation (local)

1. Clone repo: git clone git@github.com:EQAR/deqar-docs.git
2. cd ./deqar-docs
3. Create Python environment (virtualenv env, . env/bin/activate)
4. Install MkDocs: pip install -r requirements.txt
5. mkdocs serve
6. Visit http://127.0.0.1:8000/ in your browser.
7. Edit/create pages in Markdown.
8. Don't forget to add pages to mkdocs.yml.
9. Commit changes.
10. This will help: http://www.mkdocs.org/user-guide/writing-your-docs/

Deploy (GitHub pages)

1. Build version: mike deploy [version]
2. Push all branches (incl. gh-pages): git push --all