summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: 80cc87bb7fda36790334a1944c3aee8e12b030b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
.. natsort documentation master file, created by
   sphinx-quickstart on Thu Jul 17 21:01:29 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

natsort: Simple yet flexible natural sorting in Python.
=======================================================

    - Source Code: https://github.com/SethMMorton/natsort
    - Downloads: https://pypi.org/project/natsort/
    - Documentation: https://natsort.readthedocs.io/

Please see the `GitHub main page <https://github.com/SethMMorton/natsort#natsort>`_
for everything else, including

    - Quick description
    - Basic examples
    - FAQ
    - Requirements and optional dependencies
    - Installation instructions
    - Testing instructions
    - Deprecation schedule

.. toctree::
   :maxdepth: 2
   :numbered:

   howitworks.rst
   examples.rst
   api.rst
   locale_issues.rst
   shell.rst
   changelog.rst

Indices and tables
==================

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