Add Docs Linter; Add .readthedoc Config File; Update Docs (#38)

linode · Mar 28, 2024 · 394e87a · 394e87a
1 parent 7757898
commit 394e87a
Show file tree

Hide file tree

Showing 13 changed files with 57 additions and 10 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,16 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: latest
+sphinx:
+  configuration: docs/conf.py
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc
diff --git a/Makefile b/Makefile
@@ -67,6 +67,7 @@ lint:
 	$(PYTHON) -m autoflake --check linode_metadata test
 	$(PYTHON) -m black --check --verbose linode_metadata test
 	$(PYTHON) -m pylint linode_metadata
+	sphinx-lint docs
 
 .PHONY: black
 black:

diff --git a/README.md b/README.md
@@ -1,5 +1,10 @@
 # Linode Metadata Client for Python
 
+[![Unit Tests](https://github.com/linode/py-metadata/actions/workflows/unit-tests.yml/badge.svg?branch=main)](https://github.com/linode/py-metadata/actions/workflows/unit-tests.yml)
+[![E2E Tests](https://github.com/linode/py-metadata/actions/workflows/e2e-suite.yml/badge.svg?branch=main)](https://github.com/linode/py-metadata/actions/workflows/e2e-suite.yml)
+[![PyPI version](https://badge.fury.io/py/linode-metadata.svg)](https://badge.fury.io/py/linode-metadata)
+[![Documentation Status](https://readthedocs.org/projects/linode-metadata/badge/?version=latest)](https://linode-metadata.readthedocs.io/en/latest/?badge=latest)
+
 This package allows Python projects to easily interact with the [Linode Metadata Service](https://www.linode.com/docs/products/compute/compute-instances/guides/metadata/?tabs=linode-api).
 
 ## Getting Started

diff --git a/docs/conf.py b/docs/conf.py
@@ -29,3 +29,5 @@
 
 html_theme = 'alabaster'
 html_static_path = ['_static']
+
+autoclass_content = 'both'
diff --git a/docs/index.rst b/docs/index.rst
@@ -28,6 +28,7 @@ Table of Contents
    :maxdepth: 2
 
    linode_metadata/metadata_client
+   linode_metadata/watcher
    linode_metadata/objects/instance
    linode_metadata/objects/networking
    linode_metadata/objects/ssh_keys

diff --git a/docs/linode_metadata/metadata_client.rst b/docs/linode_metadata/metadata_client.rst
@@ -1,5 +1,8 @@
-Metadata Client Object
+Metadata Clients
 ======================
 
-.. autoclass:: linode_metadata.MetadataClient
-    :members:
+.. autoclass:: linode_metadata.metadata_client.MetadataClient
+    :members:
+
+.. autoclass:: linode_metadata.metadata_client.AsyncMetadataClient
+    :members:
diff --git a/docs/linode_metadata/objects/error.rst b/docs/linode_metadata/objects/error.rst
@@ -3,4 +3,4 @@ Error Objects
 
 .. automodule:: linode_metadata.objects.error
     :members:
-    :undoc-members:
+    :undoc-members:
diff --git a/docs/linode_metadata/objects/instance.rst b/docs/linode_metadata/objects/instance.rst
@@ -3,4 +3,4 @@ Instance Objects
 
 .. automodule:: linode_metadata.objects.instance
     :members:
-    :undoc-members:
+    :undoc-members:
diff --git a/docs/linode_metadata/objects/networking.rst b/docs/linode_metadata/objects/networking.rst
@@ -1,6 +1,6 @@
 Networking Objects
-================
+==================
 
 .. automodule:: linode_metadata.objects.networking
     :members:
-    :undoc-members:
+    :undoc-members:
diff --git a/docs/linode_metadata/objects/ssh_keys.rst b/docs/linode_metadata/objects/ssh_keys.rst
@@ -3,4 +3,4 @@ SSH Key Objects
 
 .. automodule:: linode_metadata.objects.ssh_keys
     :members:
-    :undoc-members:
+    :undoc-members:
diff --git a/docs/linode_metadata/objects/token.rst b/docs/linode_metadata/objects/token.rst
@@ -3,4 +3,4 @@ Token Object
 
 .. automodule:: linode_metadata.objects.token
     :members:
-    :undoc-members:
+    :undoc-members:
diff --git a/docs/linode_metadata/watcher.rst b/docs/linode_metadata/watcher.rst
@@ -0,0 +1,8 @@
+Metadata Watchers
+======================
+
+.. autoclass:: linode_metadata.watcher.MetadataWatcher
+    :members:
+
+.. autoclass:: linode_metadata.watcher.AsyncMetadataWatcher
+    :members:
diff --git a/pyproject.toml b/pyproject.toml
@@ -27,7 +27,18 @@ dependencies = ["httpx"]
 dynamic = ["version"]
 
 [project.optional-dependencies]
-dev = ["pytest", "black", "isort", "pylint", "autoflake", "Sphinx>=7.2.6", "pytest-asyncio"]
+dev = [
+    "pytest",
+    "black",
+    "isort",
+    "pylint",
+    "autoflake",
+    "Sphinx>=7.2.6",
+    "pytest-asyncio",
+    "sphinx-lint",
+]
+
+doc = ["Sphinx>=7.2.6"]
 
 [project.urls]
 homepage = "https://github.com/linode/py-metadata"
Original file line number	Diff line number	Diff line change
Expand Up		@@ -29,3 +29,5 @@

		html_theme = 'alabaster'
		html_static_path = ['_static']

		autoclass_content = 'both'