diff --git a/doc/README.md b/doc/README.md index 3a611b7..d38b695 100644 --- a/doc/README.md +++ b/doc/README.md @@ -3,12 +3,15 @@ The documentation is published through the `gh-pages` branch. To publish the documentation, you need to clone the `gh-pages` branch of this repository into -`docs/gh-pages`. In `docs`, do: +`doc/gh-pages`. In `doc`, do: git clone -b gh-pages git@github.com:larsimmisch/pyalsaaudio.git gh-pages -Once that is setup, you can publish new documentation using: +(This is a bit of a hack) + +Once that is set up, you can publish new documentation using: make publish -Be careful when new files are generated, however, you will have to add them manually. +Be careful when new files are generated, however, you will have to add them +manually to git.