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..876257335 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 = '2024, Dr. Samuel Smith and contributors' author = 'Dr. Samuel Smith' version = release = keri.__version__ diff --git a/docs/index.rst b/docs/index.rst index 32395b9b1..c6a1200f0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ ================================================== -Python Implementation of the KERI Core Libraries +Python Reference Implementation of the KERI Core Libraries ================================================== .. image:: https://img.shields.io/pypi/v/keri.svg @@ -35,6 +35,7 @@ API Reference keri_app keri_core keri_db + keri_demo keri_end keri_help keri_peer diff --git a/docs/keri_app.rst b/docs/keri_app.rst index e609031d9..67ddd7a84 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 -------------------- @@ -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..489ee4642 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..0936be573 --- /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/naming.md b/docs/naming.md index d25809958..400de3ecf 100644 --- a/docs/naming.md +++ b/docs/naming.md @@ -1,4 +1,3 @@ - # Python Style Guide for keripy The Python PEPs on style have many options or allowed variants. diff --git a/docs/requirements.txt b/docs/requirements.txt index 9ac0edb64..8d65121ec 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,2 @@ -myst-parser >= 0.16.1 -Sphinx >= 4.3.2 \ No newline at end of file +myst-parser >= 4.0.0 +Sphinx >= 8.1.3 \ No newline at end of file