Skip to content

Commit

Permalink
updated by sphinx and workflow corrected
Browse files Browse the repository at this point in the history
  • Loading branch information
hrshdhgd committed Jun 20, 2023
1 parent acd867a commit 515624a
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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' }}
Expand Down
6 changes: 2 additions & 4 deletions docs/modules.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
Technical Documentation
========
sssom
=====

.. toctree::
:maxdepth: 4

api
sssom
sphinx
65 changes: 51 additions & 14 deletions docs/sssom.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
SSSOM Submodules
================
sssom package
=============

Submodules
----------

sssom.cli module
----------------
Expand All @@ -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
--------------------

Expand All @@ -25,14 +44,21 @@ sssom.context module
:undoc-members:
:show-inheritance:

sssom.external\_context module
------------------------------

.. automodule:: sssom.external_context
:members:
:undoc-members:
:show-inheritance:

sssom.io module
---------------

.. automodule:: sssom.io
:members:
:undoc-members:
:show-inheritance:
:noindex:

sssom.parsers module
--------------------
Expand All @@ -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
----------------------------
Expand All @@ -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
-----------------
Expand All @@ -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
--------------------
Expand All @@ -86,7 +124,6 @@ sssom.writers module
:undoc-members:
:show-inheritance:


Module contents
---------------

Expand Down

0 comments on commit 515624a

Please sign in to comment.