Update documentation

2025-11-08 13:53:53 +01:00 · 2023-01-22 18:05:56 +01:00
parent 05e4ff96ca
commit 8ddb323f24
18 changed files with 148 additions and 265 deletions
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,10 +1,10 @@
 # Minimal makefile for Sphinx documentation
 #

-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = RevPiModIO2
+# 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

@@ -12,9 +12,12 @@ BUILDDIR      = _build
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

-.PHONY: help Makefile
+clean:
+	rm -R $(BUILDDIR)
+
+.PHONY: help clean 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)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,174 +1,36 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
+# Configuration file for the Sphinx documentation builder.
 #
-# RevPiModIO2 documentation build configuration file, created by
-# sphinx-quickstart on Sun Oct 20 12:38:53 2019.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html

-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../'))

+sys.path.insert(0, os.path.abspath('../src'))
 from revpimodio2 import __version__

-# -- General configuration ------------------------------------------------
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
+project = 'revpimodio2'
+copyright = '2023, Sven Sager'
+author = 'Sven Sager'
+version = __version__
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.todo',
    'sphinx.ext.viewcode'
 ]

-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = 'RevPiModIO2'
-copyright = '2019, Sven Sager (NaruX)'
-author = 'Sven Sager (NaruX)'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = __version__
-# The full version, including alpha/beta/rc tags.
-# release = ''
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = None
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
 html_theme = 'alabaster'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {}
-
-# 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']
-
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# This is required for the alabaster theme
-# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
-html_sidebars = {
-    '**': [
-        'relations.html',  # needs 'show_related': True theme option to display
-        'searchbox.html',
-    ]
-}
-
-
-# -- Options for HTMLHelp output ------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'RevPiModIO2doc'
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, 'RevPiModIO2.tex', 'RevPiModIO2 Documentation',
-     'Sven Sager (NaruX)', 'manual'),
-]
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'revpimodio2', 'RevPiModIO2 Documentation',
-     [author], 1)
-]
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (master_doc, 'RevPiModIO2', 'RevPiModIO2 Documentation',
-     author, 'RevPiModIO2', 'One line description of project.',
-     'Miscellaneous'),
-]
-
-
-
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,9 +1,9 @@
-.. RevPiModIO2 documentation master file, created by
-   sphinx-quickstart on Sun Oct 20 12:38:53 2019.
+.. revpimodio2 documentation master file, created by
+   sphinx-quickstart on Sun Jan 22 17:49:41 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

-Welcome to RevPiModIO2's documentation!
+Welcome to revpimodio2's documentation!
 =======================================

 .. toctree::
--- a/docs/modules.rst
+++ b/docs/modules.rst
@@ -1,5 +1,5 @@
-revpimodio2
-===========
+src
+===

 .. toctree::
   :maxdepth: 4
--- a/docs/revpimodio2.app.rst
+++ b/docs/revpimodio2.app.rst
@@ -1,7 +0,0 @@
-revpimodio2\.app module
-=======================
-
-.. automodule:: revpimodio2.app
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/docs/revpimodio2.device.rst
+++ b/docs/revpimodio2.device.rst
@@ -1,7 +0,0 @@
-revpimodio2\.device module
-==========================
-
-.. automodule:: revpimodio2.device
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/docs/revpimodio2.helper.rst
+++ b/docs/revpimodio2.helper.rst
@@ -1,7 +0,0 @@
-revpimodio2\.helper module
-==========================
-
-.. automodule:: revpimodio2.helper
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/docs/revpimodio2.io.rst
+++ b/docs/revpimodio2.io.rst
@@ -1,7 +0,0 @@
-revpimodio2\.io module
-======================
-
-.. automodule:: revpimodio2.io
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/docs/revpimodio2.modio.rst
+++ b/docs/revpimodio2.modio.rst
@@ -1,7 +0,0 @@
-revpimodio2\.modio module
-=========================
-
-.. automodule:: revpimodio2.modio
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/docs/revpimodio2.netio.rst
+++ b/docs/revpimodio2.netio.rst
@@ -1,7 +0,0 @@
-revpimodio2\.netio module
-=========================
-
-.. automodule:: revpimodio2.netio
-    :members:
-    :undoc-members:
-    :show-inheritance:
--- a/docs/revpimodio2.rst
+++ b/docs/revpimodio2.rst
@@ -4,20 +4,82 @@ revpimodio2 package
 Submodules
 ----------

-.. toctree::
+revpimodio2.app module
+----------------------

-   revpimodio2.app
-   revpimodio2.device
-   revpimodio2.helper
-   revpimodio2.io
-   revpimodio2.modio
-   revpimodio2.netio
-   revpimodio2.summary
+.. automodule:: revpimodio2.app
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+revpimodio2.device module
+-------------------------
+
+.. automodule:: revpimodio2.device
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+revpimodio2.errors module
+-------------------------
+
+.. automodule:: revpimodio2.errors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+revpimodio2.helper module
+-------------------------
+
+.. automodule:: revpimodio2.helper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+revpimodio2.io module
+---------------------
+
+.. automodule:: revpimodio2.io
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+revpimodio2.modio module
+------------------------
+
+.. automodule:: revpimodio2.modio
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+revpimodio2.netio module
+------------------------
+
+.. automodule:: revpimodio2.netio
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+revpimodio2.pictory module
+--------------------------
+
+.. automodule:: revpimodio2.pictory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+revpimodio2.summary module
+--------------------------
+
+.. automodule:: revpimodio2.summary
+   :members:
+   :undoc-members:
+   :show-inheritance:

 Module contents
 ---------------

 .. automodule:: revpimodio2
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/docs/revpimodio2.summary.rst
+++ b/docs/revpimodio2.summary.rst
@@ -1,7 +0,0 @@
-revpimodio2\.summary module
-===========================
-
-.. automodule:: revpimodio2.summary
-    :members:
-    :undoc-members:
-    :show-inheritance: