1
0
Fork 0
mirror of https://github.com/polybar/polybar.git synced 2024-11-18 13:55:11 -05:00

doc: Remove sphinx theme from readme

For local previews the sphinx_rtd_theme is not used, only in read the
docs.
This commit is contained in:
patrick96 2018-12-14 16:23:59 +01:00 committed by Patrick Ziegler
parent aec34c11f1
commit 3111bee143

View file

@ -7,9 +7,8 @@ The html documentation and man pages are built automatically when you build with
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.
The documentation uses [Sphinx](http://www.sphinx-doc.org/en/stable/) to generate the documentation, so you will need to
have that installed.
To generate the documentation you first need to configure polybar the same as when you compile it (`cmake ..` in `build`
folder).