Fix documentation

Lightmatter · Feb 28, 2024 · fd9e44c · fd9e44c
1 parent 5c8742b
commit fd9e44c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 63 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -5,11 +5,12 @@
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import welkin
 
-project = "foobar"
-copyright = "2024, Sam Morgan"
-author = "Sam Morgan"
-release = "1"
+project = welkin.__name__
+copyright = welkin.__copyright__
+author = welkin.__author__
+release = welkin.__version__
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,62 +3,5 @@
 
    self
 
-#########
-welkin-health
-#########
-**A Python wrapper of the Welkin Health API**
-
-|Version| |License|
-
-.. |Version| image:: https://img.shields.io/pypi/v/welkin
-   :target: https://pypi.org/project/welkin/
-
-.. |License| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
-   :target: https://www.gnu.org/licenses/gpl-3.0
-
-This package allows Python developers to write software that makes use of the Welkin Health API. Functions available in the API are mirrored in this package as closely as possible, translating JSON responses to Python objects. You can find the current documentation for the Welkin Health API here:
-
-`Welkin Health API Documentation <https://developers.welkinhealth.com/>`_
-
-**********
-Installing
-**********
-.. code-block::
-
-   pip install welkin
-
-***********
-Quick Start
-***********
-.. code-block::
-
-   from welkin import Client
-
-   welkin = Client(
-      tenant="gh", api_client="VBOPNRYRWJIP", secret_key="+}B{KGTG6#zG%P;tQm0C"
-   )
-
-   # Create a calendar event
-   patient = welkin.Patient(id="6801d498-26f4-4aee-961b-5daffcf193c8")
-   user = welkin.User(username="johndoe")
-   event = welkin.Calendar(
-      start="2020-01-01T00:00:00.000Z",
-      end="2020-01-31T23:59:59.000Z",
-      patient=patient,
-      host=user,
-   ).post()
-
-   # Get a calendar event by ID
-   event = welkin.Calendar(id="313c2029-493b-4114-8b86-788d631a1851").get()
-
-   # Get a single calendar event
-   event = welkin.Calendar().get(id="313c2029-493b-4114-8b86-788d631a1851")
-
-   # Search for calendar events with pagination
-   events = welkin.Calendar().get(
-      from_date="2020-01-15T14:00:00.000Z",
-      to_date="2020-02-11T00:00:00.000Z",
-      paginate=True,
-   )
-   for event in events:
-      print(event)
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_