fix: docs after the refactor (#192)

Author: Niraj-Kamdar

.readthedocs.yaml

@@ -0,0 +1,43 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+  jobs:
+    post_create_environment:
+      # Install poetry
+      # https://python-poetry.org/docs/#installing-manually
+      - pip install poetry
+      # Tell poetry to not use a virtual environment
+      - poetry config virtualenvs.create false
+    post_install:
+      # Install dependencies with 'docs' dependency group
+      # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
+      - cd docs && poetry install && cd ..
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#    install:
+#    - requirements: docs/requirements.txt

docs/build.sh

@@ -0,0 +1 @@
+sphinx-build source/ build

docs/clean.sh

@@ -0,0 +1 @@
+rm -Rf ./source/**/*.rst

docs/docgen.sh

@@ -0,0 +1,8 @@
+sphinx-apidoc ../packages/polywrap-msgpack/polywrap_msgpack -o ./source/polywrap-msgpack -e
+sphinx-apidoc ../packages/polywrap-manifest/polywrap_manifest -o ./source/polywrap-manifest -e
+sphinx-apidoc ../packages/polywrap-core/polywrap_core -o ./source/polywrap-core -e
+sphinx-apidoc ../packages/polywrap-wasm/polywrap_wasm -o ./source/polywrap-wasm -e
+sphinx-apidoc ../packages/polywrap-plugin/polywrap_plugin -o ./source/polywrap-plugin -e
+sphinx-apidoc ../packages/polywrap-uri-resolvers/polywrap_uri_resolvers -o ./source/polywrap-uri-resolvers -e
+sphinx-apidoc ../packages/polywrap-client/polywrap_client -o ./source/polywrap-client -e
+sphinx-apidoc ../packages/polywrap-client-config-builder/polywrap_client_config_builder -o ./source/polywrap-client-config-builder -e

docs/poetry.lock

@@ -7,7 +7,6 @@ name = "docs"
 version = "0.1.0"
 description = ""
 authors = ["Niraj <niraj@polywrap.io>"]
-readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.10"
@@ -22,5 +21,4 @@ polywrap-client-config-builder = { path = "../packages/polywrap-client-config-bu
 
 [tool.poetry.group.dev.dependencies]
 sphinx = "^6.1.3"
-sphinx-rtd-theme = "^1.2.0"
-
+sphinx-rtd-theme = "^1.2.0"

docs/pyproject.toml

@@ -7,7 +7,7 @@ Welcome to polywrap-client's documentation!
 ===========================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Contents:
 
    polywrap-msgpack/modules.rst
@@ -20,7 +20,6 @@ Welcome to polywrap-client's documentation!
    polywrap-client-config-builder/modules.rst
 
 
-
 Indices and tables
 ==================
 

docs/source/index.rst

@@ -0,0 +1,7 @@
+polywrap\_core.types.invoke\_options module
+===========================================
+
+.. automodule:: polywrap_core.types.invoke_options
+   :members:
+   :undoc-members:
+   :show-inheritance: