Merge pull request #7 from sandialabs/read-the-docs

docs: Prepare for ReadTheDocs

.readthedocs.yaml

@@ -0,0 +1,26 @@
+# Read the Docs configuration file for Sphinx projects.
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for
+# details.
+
+# Required.
+version: 2
+
+# Set the OS, Python version, and other tools you need.
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.9"
+
+# Build documentation in the "doc/" directory with Sphinx.
+sphinx:
+  fail_on_warning: true
+  configuration: doc/source/conf.py
+
+# Declare Python requirements for building the documentation.
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: requirements.txt
+    - requirements: doc/requirements.txt
+    - requirements: example/requirements.txt

doc/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     = source
+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)

doc/make-html.bash

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+ORIG_DIR=$(pwd)
+SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &> /dev/null && pwd)
+cd "${SCRIPT_DIR}" || exit 1
+make clean
+python3 -m pip uninstall -y shell-logger
+cd ..
+python3 -m pip install .
+cd "${SCRIPT_DIR}" || exit 1
+make html
+cd "${ORIG_DIR}" || exit 1

doc/requirements.txt

@@ -1,5 +1,9 @@
-# Requirements for building the `ShellLogger` documentation.
+# Requirements for building the `shell-logger` documentation.
 
 sphinx
 sphinx-argparse
+sphinx-autodoc-typehints
+sphinx-copybutton
 sphinx-rtd-theme
+sphinxcontrib-programoutput
+sphinxcontrib-spelling

doc/source/conf.py

@@ -1,17 +1,9 @@
-#!/usr/bin/env python3
+"""
+Configuration file for the Sphinx documentation builder.
 
-# 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:
-# 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.
-#
+For the full list of built-in configuration values, see the documentation:
+https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""
 from pathlib import Path
 import sys
 
@@ -31,9 +23,6 @@
 
 # -- 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.coverage",
@@ -43,24 +32,21 @@
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinxarg.ext",
+    "sphinx_autodoc_typehints",
+    "sphinx_copybutton",
     "sphinx_rtd_theme",
+    "sphinxcontrib.programoutput",
+    "sphinxcontrib.spelling",
 ]
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
-# 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 = []
-
 
 # -- 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_static_path = ["_static"]
 
 # -- AutoDoc Configuration ---------------------------------------------------
 

example/requirements.txt

@@ -0,0 +1 @@
+# Requirements for running the `shell-logger` examples.