polywrap · Niraj-Kamdar · Jun 14, 2023 · Jun 3, 2023 · Jun 3, 2023 · Jun 3, 2023
diff --git a/.readthedocs.yaml b/.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
diff --git a/docs/build.sh b/docs/build.sh
@@ -0,0 +1 @@
+sphinx-build source/ build
diff --git a/docs/clean.sh b/docs/clean.sh
@@ -0,0 +1 @@
+rm -Rf ./source/**/*.rst
diff --git a/docs/docgen.sh b/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
diff --git a/docs/poetry.lock b/docs/poetry.lock
diff --git a/docs/pyproject.toml b/docs/pyproject.toml
@@ -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"
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -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
 ==================
 

diff --git a/docs/source/polywrap-core/polywrap_core.types.invoke_args.rst b/docs/source/polywrap-core/polywrap_core.types.invoke_args.rst
diff --git a/docs/source/polywrap-core/polywrap_core.types.invoke_options.rst b/docs/source/polywrap-core/polywrap_core.types.invoke_options.rst
@@ -0,0 +1,7 @@
+polywrap\_core.types.invoke\_options module
+===========================================
+
+.. automodule:: polywrap_core.types.invoke_options
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/polywrap-core/polywrap_core.types.options.file_options.rst b/docs/source/polywrap-core/polywrap_core.types.options.file_options.rst
diff --git a/docs/source/polywrap-core/polywrap_core.types.options.invoke_options.rst b/docs/source/polywrap-core/polywrap_core.types.options.invoke_options.rst
diff --git a/docs/source/polywrap-core/polywrap_core.types.options.manifest_options.rst b/docs/source/polywrap-core/polywrap_core.types.options.manifest_options.rst
diff --git a/docs/source/polywrap-core/polywrap_core.types.options.rst b/docs/source/polywrap-core/polywrap_core.types.options.rst
diff --git a/docs/source/polywrap-core/polywrap_core.types.options.uri_resolver_options.rst b/docs/source/polywrap-core/polywrap_core.types.options.uri_resolver_options.rst
diff --git a/docs/source/polywrap-core/polywrap_core.types.rst b/docs/source/polywrap-core/polywrap_core.types.rst
@@ -1,14 +1,6 @@
 polywrap\_core.types package
 ============================
 
-Subpackages
------------
-
-.. toctree::
-   :maxdepth: 4
-
-   polywrap_core.types.options
-
 Submodules
 ----------
 
@@ -17,15 +9,13 @@ Submodules
 
    polywrap_core.types.client
    polywrap_core.types.config
-   polywrap_core.types.env
    polywrap_core.types.errors
    polywrap_core.types.file_reader
    polywrap_core.types.invocable
-   polywrap_core.types.invoke_args
+   polywrap_core.types.invoke_options
    polywrap_core.types.invoker
    polywrap_core.types.invoker_client
    polywrap_core.types.uri
-   polywrap_core.types.uri_like
    polywrap_core.types.uri_package
    polywrap_core.types.uri_package_wrapper
    polywrap_core.types.uri_resolution_context

diff --git a/docs/source/polywrap-core/polywrap_core.types.uri_like.rst b/docs/source/polywrap-core/polywrap_core.types.uri_like.rst
diff --git a/docs/source/polywrap-core/polywrap_core.utils.build_clean_uri_history.rst b/docs/source/polywrap-core/polywrap_core.utils.build_clean_uri_history.rst
@@ -0,0 +1,7 @@
+polywrap\_core.utils.build\_clean\_uri\_history module
+======================================================
+
+.. automodule:: polywrap_core.utils.build_clean_uri_history
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/polywrap-core/polywrap_core.utils.get_env_from_resolution_path.rst b/docs/source/polywrap-core/polywrap_core.utils.get_env_from_resolution_path.rst
@@ -0,0 +1,7 @@
+polywrap\_core.utils.get\_env\_from\_resolution\_path module
+============================================================
+
+.. automodule:: polywrap_core.utils.get_env_from_resolution_path
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/polywrap-core/polywrap_core.utils.get_implementations.rst b/docs/source/polywrap-core/polywrap_core.utils.get_implementations.rst
@@ -0,0 +1,7 @@
+polywrap\_core.utils.get\_implementations module
+================================================
+
+.. automodule:: polywrap_core.utils.get_implementations
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/polywrap-core/polywrap_core.utils.instance_of.rst b/docs/source/polywrap-core/polywrap_core.utils.instance_of.rst
diff --git a/docs/source/polywrap-core/polywrap_core.utils.maybe_async.rst b/docs/source/polywrap-core/polywrap_core.utils.maybe_async.rst
diff --git a/docs/source/polywrap-core/polywrap_core.utils.rst b/docs/source/polywrap-core/polywrap_core.utils.rst
@@ -7,8 +7,9 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
-   polywrap_core.utils.instance_of
-   polywrap_core.utils.maybe_async
+   polywrap_core.utils.build_clean_uri_history
+   polywrap_core.utils.get_env_from_resolution_path
+   polywrap_core.utils.get_implementations
 
 Module contents
 ---------------

diff --git a/docs/source/polywrap-manifest/polywrap_manifest.errors.rst b/docs/source/polywrap-manifest/polywrap_manifest.errors.rst
@@ -0,0 +1,7 @@
+polywrap\_manifest.errors module
+================================
+
+.. automodule:: polywrap_manifest.errors
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/polywrap-manifest/polywrap_manifest.rst b/docs/source/polywrap-manifest/polywrap_manifest.rst
@@ -8,6 +8,7 @@ Submodules
    :maxdepth: 4
 
    polywrap_manifest.deserialize
+   polywrap_manifest.errors
    polywrap_manifest.manifest
    polywrap_manifest.wrap_0_1
 

diff --git a/...polywrap-core/polywrap_core.types.env.rst → ...ywrap-msgpack/polywrap_msgpack.errors.rst b/...polywrap-core/polywrap_core.types.env.rst → ...ywrap-msgpack/polywrap_msgpack.errors.rst
@@ -1,7 +1,7 @@
-polywrap\_core.types.env module
+polywrap\_msgpack.errors module
 ===============================
 
-.. automodule:: polywrap_core.types.env
+.. automodule:: polywrap_msgpack.errors
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/polywrap-msgpack/polywrap_msgpack.rst b/docs/source/polywrap-msgpack/polywrap_msgpack.rst
@@ -17,6 +17,7 @@ Submodules
 
    polywrap_msgpack.decoder
    polywrap_msgpack.encoder
+   polywrap_msgpack.errors
    polywrap_msgpack.sanitize
 
 Module contents

diff --git a/docs/source/polywrap-plugin/polywrap_plugin.resolution_context_override_client.rst b/docs/source/polywrap-plugin/polywrap_plugin.resolution_context_override_client.rst
@@ -0,0 +1,7 @@
+polywrap\_plugin.resolution\_context\_override\_client module
+=============================================================
+
+.. automodule:: polywrap_plugin.resolution_context_override_client
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/polywrap-plugin/polywrap_plugin.rst b/docs/source/polywrap-plugin/polywrap_plugin.rst
@@ -9,6 +9,7 @@ Submodules
 
    polywrap_plugin.module
    polywrap_plugin.package
+   polywrap_plugin.resolution_context_override_client
    polywrap_plugin.wrapper
 
 Module contents

diff --git a/docs/source/polywrap-uri-resolvers/polywrap_uri_resolvers.resolvers.aggregator.rst b/docs/source/polywrap-uri-resolvers/polywrap_uri_resolvers.resolvers.aggregator.rst
@@ -8,6 +8,7 @@ Submodules
    :maxdepth: 4
 
    polywrap_uri_resolvers.resolvers.aggregator.uri_resolver_aggregator
+   polywrap_uri_resolvers.resolvers.aggregator.uri_resolver_aggregator_base
 
 Module contents
 ---------------

diff --git a/...rs/polywrap_uri_resolvers.resolvers.aggregator.uri_resolver_aggregator_base.rst b/...rs/polywrap_uri_resolvers.resolvers.aggregator.uri_resolver_aggregator_base.rst
@@ -0,0 +1,7 @@
+polywrap\_uri\_resolvers.resolvers.aggregator.uri\_resolver\_aggregator\_base module
+====================================================================================
+
+.. automodule:: polywrap_uri_resolvers.resolvers.aggregator.uri_resolver_aggregator_base
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/...olywrap-uri-resolvers/polywrap_uri_resolvers.resolvers.cache.cache_resolver.rst b/...olywrap-uri-resolvers/polywrap_uri_resolvers.resolvers.cache.cache_resolver.rst
diff --git a/...ers/polywrap_uri_resolvers.resolvers.cache.resolution_result_cache_resolver.rst b/...ers/polywrap_uri_resolvers.resolvers.cache.resolution_result_cache_resolver.rst
@@ -0,0 +1,7 @@
+polywrap\_uri\_resolvers.resolvers.cache.resolution\_result\_cache\_resolver module
+===================================================================================
+
+.. automodule:: polywrap_uri_resolvers.resolvers.cache.resolution_result_cache_resolver
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/polywrap-uri-resolvers/polywrap_uri_resolvers.resolvers.cache.rst b/docs/source/polywrap-uri-resolvers/polywrap_uri_resolvers.resolvers.cache.rst
@@ -7,8 +7,7 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
-   polywrap_uri_resolvers.resolvers.cache.cache_resolver
-   polywrap_uri_resolvers.resolvers.cache.request_synchronizer_resolver
+   polywrap_uri_resolvers.resolvers.cache.resolution_result_cache_resolver
 
 Module contents
 ---------------

diff --git a/...s.cache.request_synchronizer_resolver.rst → ...rs.legacy.package_to_wrapper_resolver.rst b/...s.cache.request_synchronizer_resolver.rst → ...rs.legacy.package_to_wrapper_resolver.rst
@@ -1,7 +1,7 @@
-polywrap\_uri\_resolvers.resolvers.cache.request\_synchronizer\_resolver module
+polywrap\_uri\_resolvers.resolvers.legacy.package\_to\_wrapper\_resolver module
 ===============================================================================
 
-.. automodule:: polywrap_uri_resolvers.resolvers.cache.request_synchronizer_resolver
+.. automodule:: polywrap_uri_resolvers.resolvers.legacy.package_to_wrapper_resolver
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/polywrap-uri-resolvers/polywrap_uri_resolvers.resolvers.legacy.rst b/docs/source/polywrap-uri-resolvers/polywrap_uri_resolvers.resolvers.legacy.rst
@@ -1,6 +1,14 @@
 polywrap\_uri\_resolvers.resolvers.legacy package
 =================================================
 
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   polywrap_uri_resolvers.resolvers.legacy.wrapper_cache
+
 Submodules
 ----------
 
@@ -9,7 +17,9 @@ Submodules
 
    polywrap_uri_resolvers.resolvers.legacy.base_resolver
    polywrap_uri_resolvers.resolvers.legacy.fs_resolver
+   polywrap_uri_resolvers.resolvers.legacy.package_to_wrapper_resolver
    polywrap_uri_resolvers.resolvers.legacy.redirect_resolver
+   polywrap_uri_resolvers.resolvers.legacy.wrapper_cache_resolver
 
 Module contents
 ---------------

diff --git a/...lywrap_uri_resolvers.resolvers.legacy.wrapper_cache.in_memory_wrapper_cache.rst b/...lywrap_uri_resolvers.resolvers.legacy.wrapper_cache.in_memory_wrapper_cache.rst
@@ -0,0 +1,7 @@
+polywrap\_uri\_resolvers.resolvers.legacy.wrapper\_cache.in\_memory\_wrapper\_cache module
+==========================================================================================
+
+.. automodule:: polywrap_uri_resolvers.resolvers.legacy.wrapper_cache.in_memory_wrapper_cache
+   :members:
+   :undoc-members:
+   :show-inheritance: