polybar/doc
patrick96 b49f325e1e doc: Add language to code-blocks 2020-12-24 12:46:02 +01:00
..
_static doc: Finish legacy action migration table 2020-11-26 20:53:53 +01:00
dev doc: Add language to code-blocks 2020-12-24 12:46:02 +01:00
man feat(config): Try to load config.ini (#2324) 2020-12-23 17:52:30 +01:00
user doc(actions): Point user to doc when using legacy actions 2020-11-26 20:53:53 +01:00
.gitignore build: Allow doc to build as its own project 2019-05-10 08:14:02 +02:00
CMakeLists.txt build: Add option to enable/disable html/manpages 2020-12-24 02:20:38 +01:00
README.md refactor(cmake): Allow targets to be enabled individually 2020-12-24 02:20:38 +01:00
conf.py fix(docs): Support out-of-tree builds (#2312) 2020-12-17 14:02:48 +01:00
index.rst doc: Finish legacy action migration table 2020-11-26 20:53:53 +01:00

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.

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.