Add documentation (#10)

* Add full documentation for the PyOpenocdClient library. The documentation includes: 
** Quick-start chapter with examples
** Full API documentation
* Added a script to build the documentation locally: build_doc.py

Author: HonzaMat

.github/workflows/build_doc.yml

@@ -0,0 +1,19 @@
+name: Build documentation
+on: [push]
+jobs:
+  build_doc:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Check out the repository code
+        uses: actions/checkout@v4
+
+      - name: Install tools for documentation
+        run: |
+          python3 -m pip install --user -r requirements_doc.txt
+
+      - name: Build the documentation
+        run: |
+          python3 build_doc.py
+
+
+

.gitignore

@@ -70,6 +70,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+doc/py_openocd_client/_build
 
 # PyBuilder
 .pybuilder/

build_doc.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3
+
+# SPDX-License-Identifier: MIT
+
+import subprocess
+import sys
+from pathlib import Path
+from typing import List
+
+
+def get_script_dir() -> Path:
+    """Return path to the script directory."""
+    return Path(__file__).resolve().parent
+
+
+def run_subproc(cmd: List[str], cwd: Path) -> None:
+    print("Running command: " + repr(cmd))
+    subprocess.check_call(cmd, cwd=cwd)
+
+
+def main() -> int:
+    work_dir = get_script_dir() / "doc" / "py_openocd_client"
+    run_subproc(
+        [
+            sys.executable,
+            "-m",
+            "sphinx",
+            "--fail-on-warning",
+            "--keep-going",
+            ".",
+            "_build/html",
+        ],
+        cwd=work_dir,
+    )
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

doc/py_openocd_client/apidocs.rst

@@ -0,0 +1,59 @@
+
+.. _api_doc:
+
+API Documentation
+=================
+
+|
+
+PyOpenocdClient
+---------------
+
+.. automodule:: py_openocd_client
+
+   .. autoclass:: py_openocd_client.PyOpenocdClient
+      :members:
+
+|
+
+Command result
+--------------
+
+.. autoclass:: py_openocd_client.OcdCommandResult
+   :members:
+
+|
+
+Exceptions
+----------
+
+.. autoexception:: OcdCommandFailedError
+   :members:
+
+.. autoexception:: OcdConnectionError
+
+.. autoexception:: OcdCommandTimeoutError
+   :members:
+
+.. autoexception:: OcdInvalidResponseError
+   :members:
+
+.. autoexception:: OcdBaseException
+
+|
+
+Other data types
+----------------
+
+.. autoclass:: py_openocd_client.BpInfo
+   :members:
+
+.. autoclass:: py_openocd_client.WpInfo
+   :members:
+
+.. autoenum:: py_openocd_client.BpType
+   :members:
+
+.. autoenum:: py_openocd_client.WpType
+   :members:
+

doc/py_openocd_client/conf.py

@@ -0,0 +1,78 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- 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
+from pathlib import Path
+import sys
+
+
+def get_script_dir() -> Path:
+    """Return path to the script directory."""
+    return Path(__file__).resolve().parent
+
+
+src_dir = get_script_dir() / ".." / ".." / "src"
+src_dir = src_dir.resolve()
+assert(src_dir.is_dir())
+
+sys.path.insert(0, str(src_dir))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'PyOpenocdClient'
+copyright = '2024, Jan Matyáš'
+author = 'Jan Matyáš'
+
+
+# -- 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.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx_design',
+    'enum_tools.autoenum',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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']
+
+# Keep the order of methods as in the source code
+autodoc_member_order = 'bysource'
+
+# -- 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'
+
+html_theme_options = {
+  "navigation_depth": 3
+}
+
+# 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']
+
+# Set up intersphinx maps
+intersphinx_mapping = {'numpy': ('https://numpy.org/doc/stable', None)}

doc/py_openocd_client/index.rst

@@ -0,0 +1,25 @@
+
+PyOpenocdClient documentation
+=============================
+
+**PyOpenocdClient** is a Python library for controlling `OpenOCD`_ software tool.
+It allows to send commands from Python programs to OpenOCD (commands like halt execution
+of the debugged target, read data from memory, read values of processor registers, ...)
+and receive results of these commands.
+
+OpenOCD is controlled by commands written in TCL language, and the set of available
+commands can be found in `OpenOCD documentation`_.
+
+.. _OpenOCD: https://openocd.org
+.. _OpenOCD documentation: https://openocd.org/pages/documentation.html
+
+Homepage of PyOpenocdClient: https://github.com/HonzaMat/PyOpenocdClient
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   installing
+   quickstart
+   apidocs

doc/py_openocd_client/installing.rst

@@ -0,0 +1,36 @@
+Installation
+============
+
+|
+
+Installing PyOpenocdClient via Pip
+----------------------------------
+
+To install PyOpenocdClient, use Pip as usual to download and install
+the package from the PyPI repository:
+
+.. code-block:: bash
+
+    $ python3 -m pip install PyOpenocdClient
+
+|
+
+Installing PyOpenocdClient from source
+--------------------------------------
+
+.. note::
+    This approach is only recommended for advanced users.
+
+Alternatively, PyOpenocdClient can be installed directly from the source code.
+This may be useful for experiments or when making own contributions to PyOpenocdClient.
+
+.. code-block:: bash
+
+    $ git clone https://github.com/HonzaMat/PyOpenocdClient.git
+    $ cd PyOpenocdClient
+
+    # Optionally, check out a specific revision
+    $ git checkout 0.1.0
+
+    $ python3 -m pip install .
+