Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #24

Merged
merged 1 commit into from
Sep 28, 2023
Merged

Improve documentation #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ build:
tools:
python: "3.11"
sphinx:
builder: singlehtml
fail_on_warning: false
9 changes: 9 additions & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
API Documentation
-----------------

.. module:: qstring

.. autofunction:: nest
.. autofunction:: unnest
.. autoexception:: ParameterTypeError
.. autodata:: Nested
1 change: 1 addition & 0 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../CHANGES.rst
3 changes: 2 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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,
Expand Down
7 changes: 7 additions & 0 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
39 changes: 6 additions & 33 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 6 additions & 0 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Installation
------------

Use pip to install from PyPI::

pip install qstring
5 changes: 5 additions & 0 deletions docs/license.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
License
-------

.. include:: ../LICENSE