PolytreeDE
/
polybar
mirror of https://github.com/polybar/polybar.git
1
0
Fork 0
Code Releases Activity

doc: Add readme with local preview instructions

This commit is contained in:
patrick96 2018-12-03 17:02:42 +01:00 committed by Patrick Ziegler
parent 166f704e58
commit 800d24c92f
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/README.md Normal file
View File

@ -0,0 +1,17 @@
Polybar Manual
==============
The official polybar documentation lives here.
The html documentation and man pages are built automatically when you build with cmake (cmake creates the custom
target `doc`).
## Preview Locally
The documentation uses [Sphinx](http://www.sphinx-doc.org/en/stable/) with the "Read The Docs" theme
[`sphinx_rtd_theme`](https://github.com/rtfd/sphinx_rtd_theme/) to generate the documentation, so you will need to
have those installed.
You can then run `make html` inside this folder and sphinx will generate the html documentation inside `doc/build/html`.
Open `doc/build/html/index.html` to read the documentation in the browser.
With `make man` it will generate the man pages in the `doc/build/man` folder.