doc/source/index.rst

   1 .. include:: ../../README.rst
   2
   3 Installation
   4 =============
   5
   6 **Latest stable release** from `PyPi <https://pypi.org/project/python-musicpd/>`_:
   7
   8 .. code:: bash
   9
  10    pip install python-musicpd
  11
  12 **Latest development version** using pip + git:
  13
  14 .. code:: bash
  15
  16     pip install git+https://gitlab.com/kaliko/python-musicpd.git
  17
  18
  19
  20 Build documentation
  21 --------------------
  22
  23 .. code:: bash
  24
  25     # Get the source
  26     git clone https://gitlab.com/kaliko/python-musicpd.git && cd python-musicpd
  27     # Installs sphinx if needed
  28     python3 -m venv venv && . ./venv/bin/activate
  29     pip install sphinx
  30     # And build
  31     python3 setup.py build_sphinx
  32     # Or call sphinx
  33     sphinx-build -d ./doc/build/doctrees doc/source -b html ./doc/build/html
  34
  35
  36 Contents
  37 =========
  38
  39 .. toctree::
  40    :maxdepth: 2
  41
  42    use.rst
  43    doc.rst
  44    contribute.rst
  45
  46
  47 Indices and tables
  48 ==================
  49
  50 * :ref:`genindex`
  51 * :ref:`modindex`
  52 * :ref:`search`
  53
  54
  55 .. vim: spell spelllang=en