Skip to content

Commit f24a8f7

Browse files
committed
Initial docs commit
1 parent 3fdd064 commit f24a8f7

File tree

5 files changed

+45
-0
lines changed

5 files changed

+45
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/site/

docs/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Generating the docs
2+
----------
3+
4+
Install requirements:
5+
6+
pip install -r requirements.txt
7+
8+
Change directories into the docs folder:
9+
10+
cd docs
11+
12+
Use [mkdocs](http://www.mkdocs.org/) structure to update the documentation. Test locally with:
13+
14+
mkdocs serve
15+
16+
Once the docs look good, publish to `gh-pages` branch with:
17+
18+
mkdocs gh-deploy --clean
19+
20+
** Note **: Never edit the generated site by hand because using `gh-deploy` blows away the `gh-pages` branch and you'll lose your edits.

docs/docs/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Welcome to Peter
2+
3+
For full documentation visit [mkdocs.org](http://mkdocs.org).
4+
5+
## Commands
6+
7+
* `mkdocs new [dir-name]` - Create a new project.
8+
* `mkdocs serve` - Start the live-reloading docs server.
9+
* `mkdocs build` - Build the documentation site.
10+
* `mkdocs help` - Print this help message.
11+
12+
## Project layout
13+
14+
mkdocs.yml # The configuration file.
15+
docs/
16+
index.md # The documentation homepage.
17+
... # Other markdown pages, images and other files.

docs/mkdocs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
site_name: My Docs
2+
theme: cinder
3+
pages:
4+
- Home: index.md

requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
mkdocs
2+
mkdocs-cinder
3+
cookiecutter

0 commit comments

Comments
 (0)