From 515624a236b46f8773bb72712199a8a6c5e74cec Mon Sep 17 00:00:00 2001 From: Harshad Hegde Date: Tue, 20 Jun 2023 15:26:21 -0500 Subject: [PATCH] updated by sphinx and workflow corrected --- .github/workflows/deploy-docs.yml | 2 +- docs/modules.rst | 6 +-- docs/sssom.rst | 65 ++++++++++++++++++++++++------- 3 files changed, 54 insertions(+), 19 deletions(-) diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 83226736..20b4196e 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -31,7 +31,7 @@ jobs: cd docs/ poetry run sphinx-apidoc -o . ../src/sssom/ --ext-autodoc -f poetry run sphinx-build -b html . _build - cp -r _build/html/* ../gh-pages/ + cp -r _build/* ../gh-pages/ - name: Deploy documentation. if: ${{ github.event_name == 'push' }} diff --git a/docs/modules.rst b/docs/modules.rst index bc097940..b060fe79 100644 --- a/docs/modules.rst +++ b/docs/modules.rst @@ -1,9 +1,7 @@ -Technical Documentation -======== +sssom +===== .. toctree:: :maxdepth: 4 - api sssom - sphinx diff --git a/docs/sssom.rst b/docs/sssom.rst index b1c6ef75..198a8ea4 100644 --- a/docs/sssom.rst +++ b/docs/sssom.rst @@ -1,5 +1,8 @@ -SSSOM Submodules -================ +sssom package +============= + +Submodules +---------- sssom.cli module ---------------- @@ -17,6 +20,22 @@ sssom.cliques module :undoc-members: :show-inheritance: +sssom.cliquesummary module +-------------------------- + +.. automodule:: sssom.cliquesummary + :members: + :undoc-members: + :show-inheritance: + +sssom.constants module +---------------------- + +.. automodule:: sssom.constants + :members: + :undoc-members: + :show-inheritance: + sssom.context module -------------------- @@ -25,6 +44,14 @@ sssom.context module :undoc-members: :show-inheritance: +sssom.external\_context module +------------------------------ + +.. automodule:: sssom.external_context + :members: + :undoc-members: + :show-inheritance: + sssom.io module --------------- @@ -32,7 +59,6 @@ sssom.io module :members: :undoc-members: :show-inheritance: - :noindex: sssom.parsers module -------------------- @@ -42,23 +68,21 @@ sssom.parsers module :undoc-members: :show-inheritance: -sssom.sparql\_util module -------------------------- +sssom.rdf\_util module +---------------------- -.. automodule:: sssom.sparql_util +.. automodule:: sssom.rdf_util :members: :undoc-members: :show-inheritance: - :noindex: -sssom.sssom\_datamodel module ------------------------------ +sssom.sparql\_util module +------------------------- -.. automodule:: sssom.sssom_datamodel +.. automodule:: sssom.sparql_util :members: :undoc-members: :show-inheritance: - :noindex: sssom.sssom\_document module ---------------------------- @@ -67,7 +91,14 @@ sssom.sssom\_document module :members: :undoc-members: :show-inheritance: - :noindex: + +sssom.typehints module +---------------------- + +.. automodule:: sssom.typehints + :members: + :undoc-members: + :show-inheritance: sssom.util module ----------------- @@ -76,7 +107,14 @@ sssom.util module :members: :undoc-members: :show-inheritance: - :noindex: + +sssom.validators module +----------------------- + +.. automodule:: sssom.validators + :members: + :undoc-members: + :show-inheritance: sssom.writers module -------------------- @@ -86,7 +124,6 @@ sssom.writers module :undoc-members: :show-inheritance: - Module contents ---------------