polybar/doc
Samuel Henrique 40cbe7ed97 Skip manpage and html doc installation if they weren't generated
Otherwise we get errors like this:

 CMake Error at doc/cmake_install.cmake:46 (file):
  file INSTALL cannot find
  "/<<PKGBUILDDIR>>/build/doc/html": No such file or
  directory.
 Call Stack (most recent call first):
  cmake_install.cmake:59 (include)
2022-03-02 23:46:46 +01:00
..
_static Create default config (#2511) 2021-10-05 13:07:19 +02:00
dev Release 3.6.0 2022-02-26 21:42:34 +01:00
man Documentation update for 3.6 2022-03-02 14:58:49 +01:00
user Use sockets for IPC (#2539) 2022-01-22 20:35:37 +01: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 doc: Defer parsing version_txt to fix an obscure bug 2022-01-31 01:20:18 +01:00
config.ini Use points in default config 2022-02-25 04:38:07 +01:00
index.rst Use sockets for IPC (#2539) 2022-01-22 20:35:37 +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.