1
0
Fork 0
mirror of https://github.com/polybar/polybar.git synced 2024-11-11 13:50:56 -05:00
polybar/doc
2021-05-24 01:07:24 +02:00
..
_static doc: Finish legacy action migration table 2020-11-26 20:53:53 +01:00
dev Add items for milestones and readthedocs to release workflow 2021-01-07 20:48:04 +01:00
man Add initial support for an escape character (#2361) 2021-01-26 19:16:29 +01:00
user doc(actions): Point user to doc when using legacy actions 2020-11-26 20:53:53 +01:00
.gitignore
CMakeLists.txt Install changelog file as part of the documentation 2021-01-07 20:48:04 +01:00
conf.py fix(build): Disable sphinx manpage section dirs 2021-05-09 21:28:22 +02:00
index.rst doc: Finish legacy action migration table 2020-11-26 20:53:53 +01:00
README.md refactor(cmake): Allow targets to be enabled individually 2020-12-24 02:20:38 +01:00

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.