Skip to content

Commit

Permalink
docs: fix Sphinx build
Browse files Browse the repository at this point in the history
  • Loading branch information
kentbull committed Oct 15, 2024
1 parent c712ba6 commit 7386e04
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 18 deletions.
Empty file added docs/_static/.gitkeep
Empty file.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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__
Expand Down
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -35,6 +35,7 @@ API Reference
keri_app
keri_core
keri_db
keri_demo
keri_end
keri_help
keri_peer
Expand Down
14 changes: 1 addition & 13 deletions docs/keri_app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,6 @@ keri.app.apping
.. automodule:: keri.app.apping
:members:

keri.app.booting
----------------

.. automodule:: keri.app.booting
:members:

keri.app.challenging
--------------------

Expand Down Expand Up @@ -85,12 +79,6 @@ keri.app.keeping
.. automodule:: keri.app.keeping
:members:

keri.app.kiwiing
----------------

.. automodule:: keri.app.kiwiing
:members:

keri.app.notifying
------------------

Expand All @@ -100,7 +88,7 @@ keri.app.notifying
keri.app.oobing
---------------

.. automodule:: keri.app.oobing
.. automodule:: keri.app.oobiing
:members:

keri.app.signaling
Expand Down
30 changes: 30 additions & 0 deletions docs/keri_core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------

Expand All @@ -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:

6 changes: 6 additions & 0 deletions docs/keri_db.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ keri.db.koming
.. automodule:: keri.db.koming
:members:

keri.db.migrations
------------------

.. automodule:: keri.db.migrations
:members:

keri.db.subing
--------------

Expand Down
8 changes: 8 additions & 0 deletions docs/keri_demo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
KERI Demo API
===========

keri.demo.demoing
-----------------

.. automodule:: keri.demo.demoing
:members:
1 change: 0 additions & 1 deletion docs/naming.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Python Style Guide for keripy

The Python PEPs on style have many options or allowed variants.
Expand Down
4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
myst-parser >= 0.16.1
Sphinx >= 4.3.2
myst-parser >= 4.0.0
Sphinx >= 8.1.3

0 comments on commit 7386e04

Please sign in to comment.