diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml index 0d86e259b..f39dfab9a 100644 --- a/.github/workflows/main.yaml +++ b/.github/workflows/main.yaml @@ -38,6 +38,10 @@ jobs: run: | python -m build python -m twine check dist/* + - name: Build the docs (results don't matter) + run: | + cd docs + python -m sphinx -T -b html -d _build/doctrees -D language=en . html type-checking: name: Run Type Checking @@ -309,7 +313,6 @@ jobs: if: ${{ github.event.pull_request.head.repo.fork }} run: pytest -v -n auto integration - build-and-publish: name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI needs: [integration-tests, unit-tests, lint-and-format, type-checking, test-package] diff --git a/docs/conf.py b/docs/conf.py index 3e1acae41..e107f14f9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -7,7 +7,8 @@ import os import sys -from importlib.metadata import version, PackageNotFoundError +from importlib.metadata import PackageNotFoundError +from importlib.metadata import version as version_func # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, @@ -28,7 +29,7 @@ def chdir(directory): try: - dist = version("weaviate") + version = version_func("weaviate") except PackageNotFoundError: # The project is not installed in readthedocs environment. Read the version with setuptools_scm. import setuptools_scm diff --git a/docs/weaviate.cluster.rst b/docs/weaviate.cluster.rst deleted file mode 100644 index d856dda82..000000000 --- a/docs/weaviate.cluster.rst +++ /dev/null @@ -1,26 +0,0 @@ -weaviate.cluster package -======================== - -.. automodule:: weaviate.cluster - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -weaviate.cluster.cluster module -------------------------------- - -.. automodule:: weaviate.cluster.cluster - :members: - :undoc-members: - :show-inheritance: - -weaviate.cluster.types module ------------------------------ - -.. automodule:: weaviate.cluster.types - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/weaviate.collections.rst b/docs/weaviate.collections.rst index 952bfe06e..1b15876bd 100644 --- a/docs/weaviate.collections.rst +++ b/docs/weaviate.collections.rst @@ -29,14 +29,6 @@ weaviate.collections.aggregate module :undoc-members: :show-inheritance: -weaviate.collections.base module --------------------------------- - -.. automodule:: weaviate.collections.base - :members: - :undoc-members: - :show-inheritance: - weaviate.collections.collection module -------------------------------------- @@ -85,14 +77,6 @@ weaviate.collections.iterator module :undoc-members: :show-inheritance: -weaviate.collections.orm module -------------------------------- - -.. automodule:: weaviate.collections.orm - :members: - :undoc-members: - :show-inheritance: - weaviate.collections.query module --------------------------------- diff --git a/docs/weaviate.gql.rst b/docs/weaviate.gql.rst deleted file mode 100644 index e1df978f2..000000000 --- a/docs/weaviate.gql.rst +++ /dev/null @@ -1,50 +0,0 @@ -weaviate.gql package -==================== - -.. automodule:: weaviate.gql - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -weaviate.gql.aggregate module ------------------------------ - -.. automodule:: weaviate.gql.aggregate - :members: - :undoc-members: - :show-inheritance: - -weaviate.gql.filter module --------------------------- - -.. automodule:: weaviate.gql.filter - :members: - :undoc-members: - :show-inheritance: - -weaviate.gql.get module ------------------------ - -.. automodule:: weaviate.gql.get - :members: - :undoc-members: - :show-inheritance: - -weaviate.gql.multi\_get module ------------------------------- - -.. automodule:: weaviate.gql.multi_get - :members: - :undoc-members: - :show-inheritance: - -weaviate.gql.query module -------------------------- - -.. automodule:: weaviate.gql.query - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/weaviate.rbac.rst b/docs/weaviate.rbac.rst new file mode 100644 index 000000000..5e66742d5 --- /dev/null +++ b/docs/weaviate.rbac.rst @@ -0,0 +1,26 @@ +weaviate.rbac +=============== + +.. automodule:: weaviate.rbac + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +weaviate.rbac.models module +----------------------------- + +.. automodule:: weaviate.rbac.models + :members: + :undoc-members: + :show-inheritance: + +weaviate.rbac.roles module +----------------------------- + +.. automodule:: weaviate.rbac.roles + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/weaviate.rst b/docs/weaviate.rst index 725179d94..f693d9c91 100644 --- a/docs/weaviate.rst +++ b/docs/weaviate.rst @@ -13,16 +13,9 @@ Subpackages :maxdepth: 4 weaviate.backup - weaviate.batch - weaviate.classification - weaviate.cluster weaviate.collections weaviate.connect - weaviate.contextionary - weaviate.data - weaviate.gql - weaviate.proto - weaviate.schema + weaviate.rbac Submodules ---------- @@ -67,13 +60,6 @@ weaviate.embedded module :undoc-members: :show-inheritance: -weaviate.error\_msgs module ---------------------------- - -.. automodule:: weaviate.error_msgs - :members: - :undoc-members: - :show-inheritance: weaviate.exceptions module -------------------------- @@ -98,11 +84,3 @@ weaviate.util module :members: :undoc-members: :show-inheritance: - -weaviate.warnings module ------------------------- - -.. automodule:: weaviate.warnings - :members: - :undoc-members: - :show-inheritance: diff --git a/weaviate/__init__.py b/weaviate/__init__.py index 704561d09..9a4b61df3 100644 --- a/weaviate/__init__.py +++ b/weaviate/__init__.py @@ -35,7 +35,6 @@ connect, embedded, exceptions, - gql, outputs, types, ) @@ -69,7 +68,6 @@ "connect", "embedded", "exceptions", - "gql", "outputs", "types", "use_async_with_custom",