mirror of https://github.com/polybar/polybar.git
2c42bae09f
This also moves the doc generation completely into cmake (no more Makefile). To generate the docs the project needs to first be configured and then `make doc` can be run. The approach used is leaned on the cmake's project own use of Sphinx: Utilities/Sphinx/CMakeLists.txt |
||
|---|---|---|
| .. | ||
| bash | ||
| man | ||
| zsh | ||
| CMakeLists.txt | ||
| README.md | ||
| conf.py.in | ||
| config.cmake | ||
| index.rst | ||
README.md
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 with the "Read The Docs" theme
sphinx_rtd_theme to generate the documentation, so you will need to
have those installed.
To generate the documentation you first need to configure polybar the same as when you compile it (cmake .. in build
folder).
After that you can run make doc to generate all of the documentation or make doc_html or make doc_man to only
generate the html documentation or the man pages.
Open build/doc/html/index.html to read the documentation in the browser.
The manual pages are placed in build/doc/man.