43556b5d92
* Use GNUInstallDirs instead of hardcoded paths This change should be a no-op in the normal case and at the same time make it easier to customise polybar builds on systems with special needs. * Avoid creating /usr/share/doc/polybar/polybar/* * Include GNUInstallDirs for the doc target itself * cmake: Don't try to set CMAKE_INSTALL_* variables Since we include GNUInstallDirs all these variables are already set * cmake: Print install directories in summary * fix(cmake): Make doc-only work like normal build This is kind of a dirty hack to force CMAKE_INSTALL_DOCDIR to use `polybar` as the project name when only polybar-doc is built. Maybe it is wiser at some point to be able to do a doc only build (and install) that can be done from the top level project. Then we would also not need to include GNUInstallDirs here |
||
|---|---|---|
| .. | ||
| man | ||
| .gitignore | ||
| CMakeLists.txt | ||
| conf.py | ||
| 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 to generate the documentation, so you will need to have that installed.
If you build polybar normally while having Sphinx installed during configuration, the documentation will be enabled and
built as well. Building the documentation can be disabled by passing -DBUILD_DOC=OFF to cmake.
Alternatively the documentation can be built without the rest of polybar, for that run cmake only on the doc
directory. For example, create a build directory in doc and then run cmake .. in there.
Once configured, all of the documentation can be generated with make doc or use make doc_html or make doc_man to
only generate the html documentation or the man pages respectively.
The HTML documentation is in doc/html/index.html in your build directory and the man pages are in doc/man.