Fix .gitignore and documentation

This commit is contained in:
Lars Immisch
2015-04-30 17:48:56 +00:00
parent 4750bb7dc4
commit bee66b741e
2 changed files with 12 additions and 2 deletions

5
.gitignore vendored
View File

@@ -1 +1,4 @@
gh-pages/
*.pyc
doc/gh-pages/
doc/html/
doc/doctrees/

View File

@@ -2,6 +2,13 @@
The documentation is published through the `gh-pages` branch.
To publish the documentation, do:
To publish the documentation, you need to clone the `gh-pages` branch of this repository into
`docs/gh-pages`. In `docs`, do:
git clone -b gh-pages git@github.com:larsimmisch/pyalsaaudio.git gh-pages
Once that is setup, you can publish new documentation using:
make publish
Be careful when new files are generated, however, you will have to add them manually.