polybar/doc
patrick96 97ce1f6e7a Add inactive tray module to default config
Replaces the commented out `tray-position`
2023-08-06 15:26:28 +02:00
..
_static Add darkmode banner (#2712) 2022-05-04 21:31:25 +02:00
dev doc: Use issue directive to link to issue 2023-04-18 15:48:38 +02:00
man Documentation update for 3.6 2022-03-02 14:58:49 +01:00
migration doc: Mention errors and warnings in migration guide 2023-04-18 15:48:38 +02:00
user doc: Fix extlinks %s substitution in caption 2023-04-18 15:48:38 +02:00
.gitignore build: Allow doc to build as its own project 2019-05-10 08:14:02 +02:00
CMakeLists.txt Skip manpage and html doc installation if they weren't generated 2022-03-02 23:46:46 +01:00
README.md refactor(cmake): Allow targets to be enabled individually 2020-12-24 02:20:38 +01:00
conf.py fix(doc): %s in extlinks caption before sphinx 4.0 2023-04-20 01:24:02 +02:00
config.ini Add inactive tray module to default config 2023-08-06 15:26:28 +02:00
index.rst doc: Add empty migration page 2023-04-18 15:48:38 +02: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.