X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=doc%2Fsource%2Findex.rst;h=d16644bf2488e33129453af7f60fe1c7f222996a;hb=9aa136ff3dc89f1f9a396f8404eb4c8064fa891c;hp=d552f002115af0d852c1bf077b0760bbc4c57cce;hpb=e4003597f43ccb041f81827b56c082cf5554098d;p=python-musicpd.git diff --git a/doc/source/index.rst b/doc/source/index.rst index d552f00..d16644b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,3 +1,6 @@ +.. SPDX-FileCopyrightText: 2018-2023 kaliko +.. SPDX-License-Identifier: LGPL-3.0-or-later + .. include:: ../../README.rst Installation @@ -13,11 +16,11 @@ Installation .. code:: bash - pip install git+https://gitlab.com/kaliko/python-musicpd.git + pip install git+https://gitlab.com/kaliko/python-musicpd.git@dev Library overview ----------------- +================ Here is a snippet allowing to list the last modified artists in the media library: .. code:: python3 @@ -43,7 +46,7 @@ Here is a snippet allowing to list the last modified artists in the media librar Build documentation --------------------- +=================== .. code:: bash @@ -52,9 +55,7 @@ Build documentation # Installs sphinx if needed python3 -m venv venv && . ./venv/bin/activate pip install sphinx - # And build - python3 setup.py build_sphinx - # Or call sphinx + # Call sphinx sphinx-build -d ./doc/build/doctrees doc/source -b html ./doc/build/html @@ -64,9 +65,11 @@ Contents .. toctree:: :maxdepth: 2 + self use.rst doc.rst commands.rst + examples.rst contribute.rst @@ -75,7 +78,6 @@ Indices and tables * :ref:`genindex` * :ref:`search` -.. * :ref:`modindex` .. vim: spell spelllang=en