Merge pull request #52 from m00sey/feat-docs

adds docs

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  apt_packages:
+    - libsodium23
+  tools:
+    python: "3.10"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+   builder: dirhtml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: requirements.txt
+   - requirements: docs/requirements.txt

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# 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)

docs/README.rst

@@ -0,0 +1,4 @@
+Signifypy
+=========
+
+Signify implementation in Python

docs/conf.py

@@ -0,0 +1,54 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(os.path.join("..", "src")))
+import signify  #noqa: E402
+
+try:
+    import sphinx_rtd_theme
+except ImportError:
+    sphinx_rtd_theme = None
+
+project = 'Signifypy'
+copyright = '2023, Phil Feairheller'
+author = 'Phil Feairheller'
+
+version = release = signify.__version__
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'myst_parser',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+if sphinx_rtd_theme:
+    html_theme = "sphinx_rtd_theme"
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+else:
+    html_theme = "default"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,29 @@
+.. Signifypy documentation master file, created by
+   sphinx-quickstart on Tue Aug  8 11:54:30 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Signifypy's documentation!
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   README
+
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   signify_app
+   signify_core
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,3 @@
+myst-parser >= 0.16.1
+Sphinx >= 4.3.2
+sphinx-rtd-theme >= 1.2.2

docs/signify_app.rst

@@ -0,0 +1,38 @@
+Signify App API
+===============
+
+signify.app.aiding
+------------------
+
+.. automodule:: signify.app.aiding
+    :members:
+
+signify.app.clienting
+---------------------
+
+.. automodule:: signify.app.clienting
+    :members:
+
+signify.app.coring
+------------------
+
+.. automodule:: signify.app.coring
+    :members:
+
+signify.app.credentialing
+-------------------------
+
+.. automodule:: signify.app.credentialing
+    :members:
+
+signify.app.ending
+------------------
+
+.. automodule:: signify.app.ending
+    :members:
+
+signify.app.escrowing
+---------------------
+
+.. automodule:: signify.app.escrowing
+    :members:

docs/signify_core.rst

@@ -0,0 +1,14 @@
+Signify Core API
+================
+
+signify.core.authing
+--------------------
+
+.. automodule:: signify.core.authing
+    :members:
+
+signify.core.keeping
+--------------------
+
+.. automodule:: signify.core.keeping
+    :members:

setup.py

@@ -70,7 +70,7 @@
     ],
     python_requires='>=3.10.4',
     install_requires=[
-        'keri>=0.6.9',
+        'keri>=1.0.0',
         'keria>=0.0.1',
         'multicommand>=1.0.0',
         'requests>=2.28',

src/signify/__init__.py

@@ -0,0 +1,7 @@
+# -*- encoding: utf-8 -*-
+"""
+main package
+"""
+
+__version__ = '0.0.1'  # also change in setup.py
+