From 47282727ff30281e826c76f323767aab2f3c6115 Mon Sep 17 00:00:00 2001 From: Kent Bull Date: Thu, 24 Oct 2024 08:56:24 -0600 Subject: [PATCH] docs: fix Sphinx build (#880) * docs: fix Sphinx build * fix: add ReadTheDocs theme reqs --- docs/Makefile | 14 +++++++++++++- docs/_static/.gitkeep | 0 docs/conf.py | 3 +-- docs/index.rst | 7 ++++--- docs/keri_app.rst | 16 ++-------------- docs/keri_core.rst | 30 ++++++++++++++++++++++++++++++ docs/keri_db.rst | 6 ++++++ docs/keri_demo.rst | 8 ++++++++ docs/keri_help.rst | 2 +- docs/keri_peer.rst | 2 +- docs/keri_vc.rst | 4 ++-- docs/naming.md | 4 ++-- docs/requirements.txt | 13 +++++++++++-- 13 files changed, 81 insertions(+), 28 deletions(-) create mode 100644 docs/_static/.gitkeep create mode 100644 docs/keri_demo.rst diff --git a/docs/Makefile b/docs/Makefile index d4bb2cbb9..882f34189 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -12,9 +12,21 @@ BUILDDIR = _build help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -.PHONY: help Makefile +.PHONY: help Makefile clean html # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + @echo + +open: + open _build/html/index.html \ No newline at end of file diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/docs/conf.py b/docs/conf.py index 5763f28ab..337033277 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ sphinx_rtd_theme = None project = 'keri' -copyright = '2022, Dr. Samuel Smith and contributors' +copyright = '2022 - 2024, Dr. Samuel Smith and contributors' author = 'Dr. Samuel Smith' version = release = keri.__version__ @@ -62,7 +62,6 @@ # if sphinx_rtd_theme: html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] else: html_theme = "default" diff --git a/docs/index.rst b/docs/index.rst index 32395b9b1..b759a8215 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ -================================================== -Python Implementation of the KERI Core Libraries -================================================== +========================================================== +Python Reference Implementation of the KERI Core Libraries +========================================================== .. image:: https://img.shields.io/pypi/v/keri.svg :target: https://pypi.org/project/keri/ @@ -32,6 +32,7 @@ API Reference .. toctree:: :maxdepth: 1 + naming keri_app keri_core keri_db diff --git a/docs/keri_app.rst b/docs/keri_app.rst index e609031d9..027ac2676 100644 --- a/docs/keri_app.rst +++ b/docs/keri_app.rst @@ -13,12 +13,6 @@ keri.app.apping .. automodule:: keri.app.apping :members: -keri.app.booting ----------------- - -.. automodule:: keri.app.booting - :members: - keri.app.challenging -------------------- @@ -32,7 +26,7 @@ keri.app.configing :members: keri.app.connecting ------------------- +------------------- .. automodule:: keri.app.connecting :members: @@ -85,12 +79,6 @@ keri.app.keeping .. automodule:: keri.app.keeping :members: -keri.app.kiwiing ----------------- - -.. automodule:: keri.app.kiwiing - :members: - keri.app.notifying ------------------ @@ -100,7 +88,7 @@ keri.app.notifying keri.app.oobing --------------- -.. automodule:: keri.app.oobing +.. automodule:: keri.app.oobiing :members: keri.app.signaling diff --git a/docs/keri_core.rst b/docs/keri_core.rst index dd9313b81..310ddfa29 100644 --- a/docs/keri_core.rst +++ b/docs/keri_core.rst @@ -7,12 +7,24 @@ keri.core.coring .. automodule:: keri.core.coring :members: +keri.core.counting +------------------ + +.. automodule:: keri.core.counting + :members: + keri.core.eventing ------------------ .. automodule:: keri.core.eventing :members: +ker.core.indexing +----------------- + +.. automodule:: keri.core.indexing + :members: + keri.core.parsing ----------------- @@ -31,3 +43,21 @@ keri.core.scheming .. automodule:: keri.core.scheming :members: +keri.core.signing +----------------- + +.. automodule:: keri.core.signing + :members: + +keri.core.streaming +------------------- + +.. automodule:: keri.core.streaming + :members: + +keri.core.structing +------------------- + +.. automodule:: keri.core.structing + :members: + diff --git a/docs/keri_db.rst b/docs/keri_db.rst index e2354b170..cb9704335 100644 --- a/docs/keri_db.rst +++ b/docs/keri_db.rst @@ -25,6 +25,12 @@ keri.db.koming .. automodule:: keri.db.koming :members: +keri.db.migrations +------------------ + +.. automodule:: keri.db.migrations + :members: + keri.db.subing -------------- diff --git a/docs/keri_demo.rst b/docs/keri_demo.rst new file mode 100644 index 000000000..00825baeb --- /dev/null +++ b/docs/keri_demo.rst @@ -0,0 +1,8 @@ +KERI Demo API +============= + +keri.demo.demoing +----------------- + +.. automodule:: keri.demo.demoing + :members: \ No newline at end of file diff --git a/docs/keri_help.rst b/docs/keri_help.rst index 81e41d82e..c8965d2d8 100644 --- a/docs/keri_help.rst +++ b/docs/keri_help.rst @@ -1,5 +1,5 @@ KERI Help API -============ +============= keri.help.helping ----------------- diff --git a/docs/keri_peer.rst b/docs/keri_peer.rst index 8947447bd..506a447f0 100644 --- a/docs/keri_peer.rst +++ b/docs/keri_peer.rst @@ -1,5 +1,5 @@ KERI Peer API -============ +============= keri.peer.exchanging -------------------- diff --git a/docs/keri_vc.rst b/docs/keri_vc.rst index 5166211ca..c99dd2587 100644 --- a/docs/keri_vc.rst +++ b/docs/keri_vc.rst @@ -1,8 +1,8 @@ KERI Verificable Credential API -============= +=============================== keri.vc.protocoling ----------------- +------------------- .. automodule:: keri.vc.protocoling :members: diff --git a/docs/naming.md b/docs/naming.md index d25809958..e5eba7146 100644 --- a/docs/naming.md +++ b/docs/naming.md @@ -1,5 +1,5 @@ - -# Python Style Guide for keripy +# Naming and Style guide +## Python Style Guide for KERIpy The Python PEPs on style have many options or allowed variants. The purpose of this document is to select a single preferred style diff --git a/docs/requirements.txt b/docs/requirements.txt index 9ac0edb64..89d1c0d09 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,11 @@ -myst-parser >= 0.16.1 -Sphinx >= 4.3.2 \ No newline at end of file +myst-parser >= 4.0.0 +Sphinx >= 8.1.3 + +sphinx-rtd-theme==3.0.1 +sphinxcontrib-applehelp==2.0.0 +sphinxcontrib-devhelp==2.0.0 +sphinxcontrib-htmlhelp==2.1.0 +sphinxcontrib-jquery==4.1 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==2.0.0 +sphinxcontrib-serializinghtml==2.0.0