From 800d24c92f434bc73b865ec9bc401c43b702108a Mon Sep 17 00:00:00 2001 From: patrick96 Date: Mon, 3 Dec 2018 17:02:42 +0100 Subject: [PATCH] doc: Add readme with local preview instructions --- doc/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 doc/README.md diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..b9aae425 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,17 @@ +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](http://www.sphinx-doc.org/en/stable/) with the "Read The Docs" theme +[`sphinx_rtd_theme`](https://github.com/rtfd/sphinx_rtd_theme/) to generate the documentation, so you will need to +have those installed. + +You can then run `make html` inside this folder and sphinx will generate the html documentation inside `doc/build/html`. +Open `doc/build/html/index.html` to read the documentation in the browser. + +With `make man` it will generate the man pages in the `doc/build/man` folder.