Add docs

.github/workflows/lint.yml

@@ -23,7 +23,7 @@ jobs:
           pip install ruff
       # Update output format to enable automatic inline annotations.
       - name: Run Ruff
-        run: ruff check --preview --output-format=github .
+        run: 'ruff check --preview --output-format=github *.py'
 
   format:
     runs-on: ubuntu-latest

.readthedocs.yaml

@@ -0,0 +1,25 @@
+# .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-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Declare the Python requirements required to build your docs.
+# Here we use the optional dependencies required in the [docs] group.
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

README.md

@@ -1,4 +1,5 @@
-# A lightweight simulation data creator and database manager
+# simplesimdb: A lightweight simulation data creator and database manager
+
 A python module for creation and management of simple simulation data.
 Essentially, a very basic database manager that creates its own data.
 

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/conf.py

@@ -0,0 +1,89 @@
+# 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
+
+from importlib.metadata import version as get_version
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "simplesimdb"
+copyright = "2021, Technical University of Denmark"
+author = "Matthias Wiesenberger"
+
+# The full version, including alpha/beta/rc tags
+release = get_version(project)
+# Major.minor version
+version = ".".join(release.split(".")[:2])
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.coverage",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx_autodoc_typehints",
+    "myst_parser",
+]
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# Numpy-doc config
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_attr_annotations = True
+napoleon_preprocess_types = True
+
+# The default role for text marked up `like this`
+default_role = "any"
+
+# Tell sphinx what the primary language being documented is.
+primary_domain = "py"
+
+# Tell sphinx what the pygments highlight language should be.
+highlight_language = "python"
+
+# Include "todo" directives in output
+todo_include_todos = True
+
+# Don't execute notebook examples
+nb_execution_mode = "off"
+
+# Parse LaTeX in notebooks
+myst_enable_extensions = [
+    "amsmath",
+    "dollarmath",
+]
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_title = f"{project} v{version} documentation"
+
+html_theme = "sphinx_book_theme"
+
+html_static_path = ["_static"]
+
+html_theme_options = {
+    "repository_url": "https://github.com/mwiesenberger/simplesimdb",
+    "repository_branch": "main",
+    "path_to_docs": "docs",
+    "use_edit_page_button": True,
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "home_page_in_toc": False,
+}
+
+pygments_style = "sphinx"
+
+# -- Options for intersphinx extension ---------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}

docs/index.rst

@@ -0,0 +1,23 @@
+.. simplesimdb documentation master file, created by
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
+
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   pages/manager
+   pages/repeater
+
+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/pages/manager.rst

@@ -0,0 +1,8 @@
+Manager
+-------
+
+.. autoclass:: simplesimdb.Manager
+   :members:
+   :undoc-members:
+   :special-members: __init__
+   :show-inheritance:

docs/pages/repeater.rst

@@ -0,0 +1,8 @@
+Repeater
+--------
+
+.. autoclass:: simplesimdb.Repeater
+   :members:
+   :undoc-members:
+   :special-members: __init__
+   :show-inheritance:

pyproject.toml

@@ -27,6 +27,12 @@ Tracker = "https://github.com/mwiesenberger/simplesimdb/issues"
 test = [
   "pytest",
 ]
+docs = [
+    "sphinx >= 5.3",
+    "sphinx_autodoc_typehints >= 1.19",
+    "sphinx-book-theme >= 0.4.0rc1",
+    "myst_parser",
+]
 
 [build-system]
 requires = [