polybar-dwm/doc/index.rst

Polybar Documentation
=====================

.. note:: This is still very much a work-in-progress. Most information is still
          to be found on our `GitHub Wiki <https://github.com/polybar/polybar/wiki>`_.
          We will migrate the wiki content step-by-step.


Welcome to the official polybar documentation.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

.. toctree::
   :maxdepth: 1
   :caption: Manual Pages:

   man/polybar.1
   man/polybar.5

.. toctree::
   :maxdepth: 1
   :caption: For Contributors:

   dev/packaging

Getting Help
============

* `Polybar Wiki <https://github.com/polybar/polybar/wiki>`_
* `Gitter <https://gitter.im/polybar/polybar>`_
* `/r/polybar <https://reddit.com/r/polybar>`_ on reddit
* ``#polybar`` on ``chat.freenode.net``
doc: Setup in-repo documentation 2018-12-01 11:12:49 +00:00			`Polybar Documentation`
			`=====================`

			`.. note:: This is still very much a work-in-progress. Most information is still`
migration: Update URLs jaagr/polybar -> polybar/polybar Travis changed their url for new projects to travis-ci.com 2019-05-06 11:51:49 +00:00			to be found on our `GitHub Wiki <https://github.com/polybar/polybar/wiki>`_.
doc: Setup in-repo documentation 2018-12-01 11:12:49 +00:00			`We will migrate the wiki content step-by-step.`


			`Welcome to the official polybar documentation.`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Contents:`

doc: Add manpage as rst file This allows us to also have the manual as part of the generated html documentation. The syntax is also easier to use. Right now the man page installed on the system is not replaced with the rst file, this will come in a later step 2018-12-02 18:05:48 +00:00			`.. toctree::`
			`:maxdepth: 1`
			`:caption: Manual Pages:`

			`man/polybar.1`
doc: Write syntax definition in polybar.5 2019-10-03 20:42:47 +00:00			`man/polybar.5`
doc: Add manpage as rst file This allows us to also have the manual as part of the generated html documentation. The syntax is also easier to use. Right now the man page installed on the system is not replaced with the rst file, this will come in a later step 2018-12-02 18:05:48 +00:00
doc: Write page for package maintainers. 2019-12-27 16:19:19 +00:00			`.. toctree::`
			`:maxdepth: 1`
			`:caption: For Contributors:`

			`dev/packaging`

doc: Setup in-repo documentation 2018-12-01 11:12:49 +00:00			`Getting Help`
			`============`

migration: Update URLs jaagr/polybar -> polybar/polybar Travis changed their url for new projects to travis-ci.com 2019-05-06 11:51:49 +00:00			* `Polybar Wiki <https://github.com/polybar/polybar/wiki>`_
doc: Add Gitter room The Gitter room https://gitter.im/polybar/polybar should serve a similar purpose as the IRC room with the benefit that messages persist and can be received when offline. From now on gitter should be the place where the polybar community lives. Reddit is great for asking longer questions in the style of a forum but not so great for quick back and forth conversations. IRC is better in that aspect but has the serious downside that you have to stay connected to get an answer and messages are not logged (only by your client). Both reddit and IRC are here to stay and I will still check them regularly, but we should encourage people to join gitter. 2019-11-25 17:39:36 +00:00			* `Gitter <https://gitter.im/polybar/polybar>`_
doc: Setup in-repo documentation 2018-12-01 11:12:49 +00:00			* `/r/polybar <https://reddit.com/r/polybar>`_ on reddit
			* ``#polybar`` on ``chat.freenode.net``