diff options
Diffstat (limited to 'docs/source/index.rst')
| -rw-r--r-- | docs/source/index.rst | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..46f8eb1 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,29 @@ +Welcome to pkb_client's documentation! +====================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + installation + usage + modules + migration_guide + +About ++++++ + +*pkb_client* is a python client for the `Porkbun <https://porkbun.com>`_ API. It supports the v3 of the API. You can +find the official documentation of the Porkbun API `here <https://api.porkbun.com/api/json/v3/documentation>`_. + +Link to the source code: `Github <https://github.com/infinityofspace/pkb_client>`_ + +*Note:* This project is not associated with Porkbun LLC. + + +Indices and tables +++++++++++++++++++ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` |