mirror of
https://github.com/larsimmisch/pyalsaaudio.git
synced 2026-04-20 01:44:48 +00:00
tidied up
This commit is contained in:
17
doc/README.md
Normal file
17
doc/README.md
Normal 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.
|
||||
Reference in New Issue
Block a user