From 9dd39d2048fd7b62bb61b0c45dc7e0d8e4ce6bf3 Mon Sep 17 00:00:00 2001 From: Storm Date: Wed, 19 Nov 2025 13:49:50 +0100 Subject: [PATCH 1/4] docs: added auto-generation of documentation ref: N25B-270 --- README.md | 22 ++++++++++++++++++++++ requirements.txt | 2 ++ src/robot_interface/state.py | 8 +++++++- 3 files changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ce43e57..badd3f2 100644 --- a/README.md +++ b/README.md @@ -146,3 +146,25 @@ If your commit fails its either: branch name != /description-of-branch , commit name != : description of the commit. : N25B-Num's + +## Documentation +Generate documentation web pages using: + +```bash +PYTHONPATH=src sphinx-apidoc -F -o docs src/robot_interface +``` + +Optionally, in the `conf.py` file in the new `docs` folder, change preferences. +For the page theme, change `html_theme` to `'sphinx_rtd_theme'`. + +In the `docs` folder: + +### Windows +```bash +.\make.bat html +``` + +### MacOS +```bash +make html +``` \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index f93c70d..c7e1990 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,3 +3,5 @@ pyaudio<=0.2.11 pytest<5 pytest-mock<3.0.0 pytest-cov<3.0.0 +sphinx +sphinx_rtd_theme \ No newline at end of file diff --git a/src/robot_interface/state.py b/src/robot_interface/state.py index b6f8ce1..cae3ce6 100644 --- a/src/robot_interface/state.py +++ b/src/robot_interface/state.py @@ -45,7 +45,13 @@ class State(object): def __getattribute__(self, name): # Enforce that the state is initialized before accessing any property (aside from the basic ones) - if name in ("initialize", "deinitialize", "is_initialized", "__dict__", "__class__"): + if name in ( + "initialize", + "deinitialize", + "is_initialized", + "__dict__", + "__class__", + "__doc__"): return object.__getattribute__(self, name) if not object.__getattribute__(self, "is_initialized"): From 1c9467d03a285aa03cc93ba4bf82547d59fd7eda Mon Sep 17 00:00:00 2001 From: JobvAlewijk Date: Wed, 19 Nov 2025 17:57:24 +0100 Subject: [PATCH 2/4] fix: conf includes correct path ref: N25B-270 --- docs/conf.py | 184 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 184 insertions(+) create mode 100644 docs/conf.py diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..345efd3 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# 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("../src")) + + +# -- Project information ----------------------------------------------------- + +project = u'robot_interface' +copyright = u'2025, Author' +author = u'Author' + +# The short X.Y version +version = u'' +# The full version, including alpha/beta/rc tags +release = u'' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# 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.viewcode', + 'sphinx.ext.todo', +] + +# 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' + +# 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 = 'en' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects 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 = None + + +# -- 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 = 'sphinx_rtd_theme' + +# 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. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'robot_interfacedoc' + + +# -- 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, 'robot_interface.tex', u'robot\\_interface Documentation', + u'Author', '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, 'robot_interface', u'robot_interface 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, 'robot_interface', u'robot_interface Documentation', + author, 'robot_interface', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True From a0a8ad2689f4087313201bfaf794a138c30d0e4f Mon Sep 17 00:00:00 2001 From: Storm Date: Wed, 19 Nov 2025 17:59:37 +0100 Subject: [PATCH 3/4] docs: changed readme ref: N25B-270 --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index badd3f2..8bde763 100644 --- a/README.md +++ b/README.md @@ -150,21 +150,26 @@ commit name != : description of the commit. ## Documentation Generate documentation web pages using: +### Linux & macOS ```bash PYTHONPATH=src sphinx-apidoc -F -o docs src/robot_interface ``` +### Windows +```bash +$env:PYTHONPATH="src"; sphinx-apidoc -F -o docs src/control_backend +``` + Optionally, in the `conf.py` file in the new `docs` folder, change preferences. -For the page theme, change `html_theme` to `'sphinx_rtd_theme'`. In the `docs` folder: +### Linux & macOS +```bash +make html +``` + ### Windows ```bash .\make.bat html -``` - -### MacOS -```bash -make html ``` \ No newline at end of file From cec29f620628d2cb09641a42756abf1c47dabac4 Mon Sep 17 00:00:00 2001 From: Storm Date: Wed, 19 Nov 2025 18:10:18 +0100 Subject: [PATCH 4/4] chore: updated .gitignore ref: N25B-270 --- .gitignore | 3 +++ README.md | 2 +- requirements.txt | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 9a65a1b..8be1803 100644 --- a/.gitignore +++ b/.gitignore @@ -217,3 +217,6 @@ __marimo__/ .DS_Store +# Docs +docs/* +!docs/conf.py diff --git a/README.md b/README.md index 8bde763..6a34642 100644 --- a/README.md +++ b/README.md @@ -172,4 +172,4 @@ make html ### Windows ```bash .\make.bat html -``` \ No newline at end of file +``` diff --git a/requirements.txt b/requirements.txt index c7e1990..981361c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,4 +4,4 @@ pytest<5 pytest-mock<3.0.0 pytest-cov<3.0.0 sphinx -sphinx_rtd_theme \ No newline at end of file +sphinx_rtd_theme