forked from auracaster/pyalsaaudio
Fix .gitignore and documentation
This commit is contained in:
5
.gitignore
vendored
5
.gitignore
vendored
@@ -1 +1,4 @@
|
||||
gh-pages/
|
||||
*.pyc
|
||||
doc/gh-pages/
|
||||
doc/html/
|
||||
doc/doctrees/
|
||||
|
||||
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user