diff --git a/.gitignore b/.gitignore index cda995f..3629a82 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ -gh-pages/ \ No newline at end of file +*.pyc +doc/gh-pages/ +doc/html/ +doc/doctrees/ diff --git a/doc/README.md b/doc/README.md index d8c0beb..3a611b7 100644 --- a/doc/README.md +++ b/doc/README.md @@ -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.