Files
pyalsaaudio/py/doc/README.md
Julian Porter be1b3e131d demo
2020-03-05 00:50:30 +00:00

18 lines
498 B
Markdown

# 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.