Peter Bull
9 years ago
5 changed files with 45 additions and 0 deletions
@ -0,0 +1,20 @@
|
||||
Generating the docs |
||||
---------- |
||||
|
||||
Install requirements: |
||||
|
||||
pip install -r requirements.txt |
||||
|
||||
Change directories into the docs folder: |
||||
|
||||
cd docs |
||||
|
||||
Use [mkdocs](http://www.mkdocs.org/) structure to update the documentation. Test locally with: |
||||
|
||||
mkdocs serve |
||||
|
||||
Once the docs look good, publish to `gh-pages` branch with: |
||||
|
||||
mkdocs gh-deploy --clean |
||||
|
||||
** Note **: Never edit the generated site by hand because using `gh-deploy` blows away the `gh-pages` branch and you'll lose your edits. |
@ -0,0 +1,17 @@
|
||||
# Welcome to Peter |
||||
|
||||
For full documentation visit [mkdocs.org](http://mkdocs.org). |
||||
|
||||
## Commands |
||||
|
||||
* `mkdocs new [dir-name]` - Create a new project. |
||||
* `mkdocs serve` - Start the live-reloading docs server. |
||||
* `mkdocs build` - Build the documentation site. |
||||
* `mkdocs help` - Print this help message. |
||||
|
||||
## Project layout |
||||
|
||||
mkdocs.yml # The configuration file. |
||||
docs/ |
||||
index.md # The documentation homepage. |
||||
... # Other markdown pages, images and other files. |
@ -0,0 +1,4 @@
|
||||
site_name: My Docs |
||||
theme: cinder |
||||
pages: |
||||
- Home: index.md |
Loading…
Reference in new issue