From: Scott Gasch Date: Sat, 28 May 2022 20:02:44 +0000 (-0700) Subject: Adding files needed to run sphinx as a pre-push hook. X-Git-Url: https://wannabe.guru.org/gitweb/?a=commitdiff_plain;h=9d828655494410b575a75e861900f62fcae80060;p=python_utils.git Adding files needed to run sphinx as a pre-push hook. --- diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/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) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..615e80a --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,64 @@ +# 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 +import sys + +sys.path.insert(0, os.path.abspath('../..')) +sys.path.insert(0, os.path.abspath('../../cached')) +sys.path.insert(0, os.path.abspath('../../collect')) +sys.path.insert(0, os.path.abspath('../../dateparse')) +sys.path.insert(0, os.path.abspath('../../ml')) +sys.path.insert(0, os.path.abspath('../../music')) +sys.path.insert(0, os.path.abspath('../../smart_home')) +sys.path.insert(0, os.path.abspath('../../tests')) +sys.path.insert(0, os.path.abspath('../../type')) +sys.path.insert(0, os.path.abspath('/home/scott/py38-venv/lib/python3.8/site-packages/')) +sys.path.insert(0, os.path.abspath('/usr/local/lib/python3.8/site-packages/')) + +# -- Project information ----------------------------------------------------- + +project = "Scott's Python Utils" +copyright = '2022, Scott Gasch' +author = 'Scott Gasch' + + +# -- 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.doctest', + 'sphinx.ext.autodoc', +] + +# 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'] + + +# -- 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' + +# 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'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..6e6da4d --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. Scott's Python Utils documentation master file, created by + sphinx-quickstart on Tue May 24 19:36:45 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Scott's Python Utils's documentation! +================================================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + modules + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search`