tidied up

This commit is contained in:
Julian Porter
2020-03-06 20:06:59 +00:00
parent a056a90c61
commit f244a70111
24 changed files with 0 additions and 299 deletions

17
doc/README.md Normal file
View File

@@ -0,0 +1,17 @@
# Publish the documentation
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
`doc/gh-pages`. In `doc`, do:
git clone -b gh-pages git@github.com:larsimmisch/pyalsaaudio.git gh-pages
(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 to git.