Browse Source

Initial docs commit

main
Peter Bull 9 years ago
parent
commit
f24a8f77c7
  1. 1
      .gitignore
  2. 20
      docs/README.md
  3. 17
      docs/docs/index.md
  4. 4
      docs/mkdocs.yml
  5. 3
      requirements.txt

1
.gitignore vendored

@ -0,0 +1 @@
docs/site/

20
docs/README.md

@ -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.

17
docs/docs/index.md

@ -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.

4
docs/mkdocs.yml

@ -0,0 +1,4 @@
site_name: My Docs
theme: cinder
pages:
- Home: index.md

3
requirements.txt

@ -0,0 +1,3 @@
mkdocs
mkdocs-cinder
cookiecutter
Loading…
Cancel
Save