Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix Sphinx build #880

Merged
merged 2 commits into from
Oct 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
@@ -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
Empty file added docs/_static/.gitkeep
Empty file.
3 changes: 1 addition & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -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"

7 changes: 4 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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
16 changes: 2 additions & 14 deletions docs/keri_app.rst
Original file line number Diff line number Diff line change
@@ -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
30 changes: 30 additions & 0 deletions docs/keri_core.rst
Original file line number Diff line number Diff line change
@@ -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:

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

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

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

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

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:
2 changes: 1 addition & 1 deletion docs/keri_help.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
KERI Help API
============
=============

keri.help.helping
-----------------
2 changes: 1 addition & 1 deletion docs/keri_peer.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
KERI Peer API
============
=============

keri.peer.exchanging
--------------------
4 changes: 2 additions & 2 deletions docs/keri_vc.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
KERI Verificable Credential API
=============
===============================

keri.vc.protocoling
----------------
-------------------

.. automodule:: keri.vc.protocoling
:members:
4 changes: 2 additions & 2 deletions docs/naming.md
Original file line number Diff line number Diff line change
@@ -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
13 changes: 11 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
myst-parser >= 0.16.1
Sphinx >= 4.3.2
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