aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2021-02-21 16:44:34 -0700
committerSean Whitton <spwhitton@spwhitton.name>2021-02-21 16:44:34 -0700
commitf4346c21894702bce72c522545a43fdab3e8edf7 (patch)
tree75a78109f864dd07f53ba7c292dabe3ec4a78eea
parenta49358817d14f59a8bff50012925a462871f116e (diff)
downloadconsfigurator-f4346c21894702bce72c522545a43fdab3e8edf7.tar.gz
add Sphinx config
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
-rw-r--r--.gitignore1
-rw-r--r--doc/Makefile9
-rw-r--r--doc/conf.py57
-rw-r--r--doc/index.rst21
-rw-r--r--doc/introduction.rst2
5 files changed, 88 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..6d42974
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+/doc/_build/
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..50d9481
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,9 @@
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = .
+BUILDDIR = _build
+
+# 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/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000..cdab50d
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,57 @@
+# 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('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Consfigurator'
+copyright = '2020-2021, Sean Whitton'
+author = 'Sean Whitton'
+
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
+
+
+# -- 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 = [
+]
+
+# 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']
+
+highlight_language = 'common-lisp'
+
+
+# -- 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 = 'haiku'
+
+# 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/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..e48bde5
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,21 @@
+Consfigurator user's manual
+===========================
+
+.. toctree::
+ :maxdepth: 1
+ :caption: Contents:
+
+ introduction
+ connections
+ properties
+ hosts
+ propspecs
+ data
+ pitfalls
+ ideas
+
+Indices and search
+==================
+
+* :ref:`genindex`
+* :ref:`search`
diff --git a/doc/introduction.rst b/doc/introduction.rst
index 682d263..62e26fa 100644
--- a/doc/introduction.rst
+++ b/doc/introduction.rst
@@ -1,8 +1,6 @@
Introduction
============
-This is the user's guide for Consfigurator.
-
Concepts and terminology
------------------------