kallithea Files · docs/index.rst

Files @ 77aa8e4cd0a2

Branch filter:

Location: kallithea/docs/index.rst

77aa8e4cd0a2 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

mads

helpers: very partial support for pygments >= 2.12

setup.py makes it clear that Kallithea only supports "Pygments >= 2.2.0, < 2.8".
Later versions are known to cause minor breakage to tests, and it hasn't been
validated that they don't expose other problems.

Pawel (aka momat) reported a problem with pygments >= 2.12 when subclassing
HtmlFormatter. The wrap outfile parameter has been dropped, and he suggested
this workaround.

The workaround seems safe and backwards compatible and nice to have, but we
still don't recommend or support using Pygments >= 2.8 .

.. _index:

#######################
Kallithea Documentation
#######################

* :ref:`genindex`
* :ref:`search`


Readme
******

.. toctree::
   :maxdepth: 1

   readme


Administrator guide
*******************

**Installation and upgrade**

.. toctree::
   :maxdepth: 1

   overview
   installation
   installation_win
   installation_win_old
   installation_iis
   installation_puppet
   upgrade

**Setup and configuration**

.. toctree::
   :maxdepth: 1

   setup
   administrator_guide/auth
   administrator_guide/vcs_setup
   usage/email
   usage/customization

**Maintenance**

.. toctree::
   :maxdepth: 1

   usage/backup
   usage/performance
   usage/debugging
   usage/troubleshooting


User guide
**********

.. toctree::
   :maxdepth: 1

   usage/general
   usage/vcs_notes
   usage/statistics
   api/api


Developer guide
***************

.. toctree::
   :maxdepth: 1

   contributing
   dev/i18n
   dev/dbmigrations


.. _python: http://www.python.org/
.. _django: http://www.djangoproject.com/
.. _mercurial: https://www.mercurial-scm.org/
.. _git: http://git-scm.com/
.. _celery: http://celeryproject.org/
.. _Sphinx: http://sphinx.pocoo.org/
.. _vcs: http://pypi.python.org/pypi/vcs