Improve documentation

- Use `language = 'en'` - Document `Nested` type - Add project description to docs - Split documentation into multiple files to have working Navigation
fastmonkeys · Sep 28, 2023 · 1e4b42b · 1e4b42b
1 parent 9fd4b3c
commit 1e4b42b
Show file tree

Hide file tree

Showing 7 changed files with 36 additions and 34 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,9 @@
+API Documentation
+-----------------
+
+.. module:: qstring
+
+.. autofunction:: nest
+.. autofunction:: unnest
+.. autoexception:: ParameterTypeError
+.. autodata:: Nested
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../CHANGES.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -66,7 +66,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -116,6 +116,7 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
+    "description": "Parse querystring parameters to nested objects",
     "github_user": "fastmonkeys",
     "github_repo": "qstring",
     "github_banner": True,

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -0,0 +1,7 @@
+Contributing
+------------
+
+To contribute to qstring `create a fork`_ on GitHub. Clone your fork, make
+some changes, and submit a pull request.
+
+.. _create a fork: https://github.com/fastmonkeys/qstring
diff --git a/docs/index.rst b/docs/index.rst
@@ -4,36 +4,9 @@ qstring
 qstring is a Python library that allows you to create nested objects from a list
 of querystring parameters.
 
-Installation
-------------
-
-Use pip to install from PyPI::
-
-    pip install qstring
-
-Contributing
-------------
-
-To contribute to qstring `create a fork`_ on GitHub. Clone your fork, make
-some changes, and submit a pull request.
-
-.. _create a fork: https://github.com/fastmonkeys/qstring
-
-
-API Documentation
------------------
-
-.. module:: qstring
-
-.. autofunction:: nest
-.. autofunction:: unnest
-.. autoexception:: ParameterTypeError
-
-
-.. include:: ../CHANGES.rst
-
-
-License
--------
-
-.. include:: ../LICENSE
+.. toctree::
+   installation
+   contributing
+   api
+   changelog
+   license
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -0,0 +1,6 @@
+Installation
+------------
+
+Use pip to install from PyPI::
+
+    pip install qstring
diff --git a/docs/license.rst b/docs/license.rst
@@ -0,0 +1,5 @@
+License
+-------
+
+.. include:: ../LICENSE
+