Merge pull request #82 from SethMMorton/consolodate-api-documentation

Consolidate API into a single page

17 files changed, 91 insertions, 136 deletions

diff --git a/docs/api.rst b/docs/api.rst
index 528a5e7..5e7a482 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -6,21 +6,92 @@
 natsort API
 ===========
 
-.. toctree::
-   :maxdepth: 2
-
-   natsort_keygen.rst
-   natsort_key.rst
-   natsorted.rst
-   versorted.rst
-   humansorted.rst
-   realsorted.rst
-   index_natsorted.rst
-   index_versorted.rst
-   index_humansorted.rst
-   index_realsorted.rst
-   order_by_index.rst
-   ns_class.rst
-   bytes.rst
-   chain.rst
-   locale_issues.rst
+.. contents::
+    :local:
+
+Standard API
+------------
+
+:func:`~natsort.natsorted`
+++++++++++++++++++++++++++
+
+.. autofunction:: natsorted
+
+The :class:`~natsort.ns` enum
++++++++++++++++++++++++++++++
+
+.. autodata:: ns
+    :annotation:
+
+:func:`~natsort.natsort_key`
+++++++++++++++++++++++++++++
+
+.. autofunction:: natsort_key
+
+:func:`~natsort.natsort_keygen`
++++++++++++++++++++++++++++++++
+
+.. autofunction:: natsort_keygen
+
+Convenience Functions
+---------------------
+
+:func:`~natsort.realsorted`
++++++++++++++++++++++++++++
+
+.. autofunction:: realsorted
+
+:func:`~natsort.humansorted`
+++++++++++++++++++++++++++++
+
+.. autofunction:: humansorted
+
+:func:`~natsort.index_natsorted`
+++++++++++++++++++++++++++++++++
+
+.. autofunction:: index_natsorted
+
+:func:`~natsort.index_realsorted`
++++++++++++++++++++++++++++++++++
+
+.. autofunction:: index_realsorted
+
+:func:`~natsort.index_humansorted`
+++++++++++++++++++++++++++++++++++
+
+.. autofunction:: index_humansorted
+
+:func:`~natsort.order_by_index`
++++++++++++++++++++++++++++++++
+
+.. autofunction:: order_by_index
+
+.. _bytes_help:
+
+Help With Bytes On Python 3
++++++++++++++++++++++++++++
+
+The official stance of :mod:`natsort` is to not support `bytes` for
+sorting; there is just too much that can go wrong when trying to automate
+conversion between `bytes` and `str`. But rather than completely give up
+on `bytes`, :mod:`natsort` provides three functions that make it easy to
+quickly decode `bytes` to `str` so that sorting is possible.
+
+.. autofunction:: decoder
+
+.. autofunction:: as_ascii
+
+.. autofunction:: as_utf8
+
+.. _function_help:
+
+Help With Creating Function Keys
+++++++++++++++++++++++++++++++++
+
+If you need to create a complicated *key* argument to (for example)
+:func:`natsorted` that is actually multiple functions called one after the other,
+the following function can help you easily perform this action. It is
+used internally to :mod:`natsort`, and has been exposed publically for
+the convenience of the user.
+
+.. autofunction:: chain_functions
diff --git a/docs/bytes.rst b/docs/bytes.rst
deleted file mode 100644
index b721e2f..0000000
--- a/docs/bytes.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-.. _bytes_help:
-
-Help With Bytes On Python 3
-===========================
-
-The official stance of :mod:`natsort` is to not support `bytes` for
-sorting; there is just too much that can go wrong when trying to automate
-conversion between `bytes` and `str`. But rather than completely give up
-on `bytes`, :mod:`natsort` provides three functions that make it easy to
-quickly decode `bytes` to `str` so that sorting is possible.
-
-.. autofunction:: decoder
-
-.. autofunction:: as_ascii
-
-.. autofunction:: as_utf8
diff --git a/docs/chain.rst b/docs/chain.rst
deleted file mode 100644
index 50536d0..0000000
--- a/docs/chain.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-.. _function_help:
-
-Help With Creating Function Keys
-================================
-
-If you need to create a complicated *key* argument to (for example)
-:func:`natsorted` that is actually multiple functions called one after the other,
-the following function can help you easily perform this action. It is
-used internally to :mod:`natsort`, and has been exposed publically for
-the convenience of the user.
-
-.. autofunction:: chain_functions
diff --git a/docs/changelog.rst b/docs/changelog.rst
index 363ae12..d8df0ea 100644
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -8,6 +8,7 @@ XX-XX-XXXX v. X.X.X
 
    - Removal of Python 2.6 and 3.3 compatibility (thanks @jdufresne)
    - Documentation, packaging, and CI cleanup (thanks @jdufresne)
+   - Consolidate API documentation into a single page
 
 09-09-2018 v. 5.4.1
 +++++++++++++++++++
diff --git a/docs/humansorted.rst b/docs/humansorted.rst
deleted file mode 100644
index af8db27..0000000
--- a/docs/humansorted.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:func:`~natsort.humansorted`
-============================
-
-.. autofunction:: humansorted
diff --git a/docs/index.rst b/docs/index.rst
index 3b0f63c..4c03f3b 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,6 +16,7 @@ Contents:
    howitworks.rst
    examples.rst
    api.rst
+   locale_issues.rst
    shell.rst
    changelog.rst
 
diff --git a/docs/index_humansorted.rst b/docs/index_humansorted.rst
deleted file mode 100644
index c920cb6..0000000
--- a/docs/index_humansorted.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:func:`~natsort.index_humansorted`
-==================================
-
-.. autofunction:: index_humansorted
diff --git a/docs/index_natsorted.rst b/docs/index_natsorted.rst
deleted file mode 100644
index 0402789..0000000
--- a/docs/index_natsorted.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:func:`~natsort.index_natsorted`
-================================
-
-.. autofunction:: index_natsorted
diff --git a/docs/index_realsorted.rst b/docs/index_realsorted.rst
deleted file mode 100644
index fdd66cf..0000000
--- a/docs/index_realsorted.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:func:`~natsort.index_realsorted`
-=================================
-
-.. autofunction:: index_realsorted
diff --git a/docs/index_versorted.rst b/docs/index_versorted.rst
deleted file mode 100644
index 0f27d13..0000000
--- a/docs/index_versorted.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:func:`~natsort.index_versorted`
-================================
-
-.. autofunction:: index_versorted
diff --git a/docs/natsort_key.rst b/docs/natsort_key.rst
deleted file mode 100644
index ba9fe25..0000000
--- a/docs/natsort_key.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:func:`~natsort.natsort_key`
-============================
-
-.. autofunction:: natsort_key
diff --git a/docs/natsort_keygen.rst b/docs/natsort_keygen.rst
deleted file mode 100644
index 288acf4..0000000
--- a/docs/natsort_keygen.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:func:`~natsort.natsort_keygen`
-===============================
-
-.. autofunction:: natsort_keygen
diff --git a/docs/natsorted.rst b/docs/natsorted.rst
deleted file mode 100644
index 88372f9..0000000
--- a/docs/natsorted.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:func:`~natsort.natsorted`
-==========================
-
-.. autofunction:: natsorted
diff --git a/docs/ns_class.rst b/docs/ns_class.rst
deleted file mode 100644
index e0b7c8e..0000000
--- a/docs/ns_class.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:class:`~natsort.ns`
-====================
-
-.. autoclass:: ns
diff --git a/docs/order_by_index.rst b/docs/order_by_index.rst
deleted file mode 100644
index aab2b05..0000000
--- a/docs/order_by_index.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:func:`~natsort.order_by_index`
-===============================
-
-.. autofunction:: order_by_index
diff --git a/docs/realsorted.rst b/docs/realsorted.rst
deleted file mode 100644
index 8ef4717..0000000
--- a/docs/realsorted.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:func:`~natsort.realsorted`
-===========================
-
-.. autofunction:: realsorted
diff --git a/docs/versorted.rst b/docs/versorted.rst
deleted file mode 100644
index d899ab0..0000000
--- a/docs/versorted.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-.. default-domain:: py
-.. currentmodule:: natsort
-
-:func:`~natsort.versorted`
-==========================
-
-.. autofunction:: versorted