diff options
author | Melody Horn <melody@boringcactus.com> | 2020-10-28 17:01:55 -0600 |
---|---|---|
committer | Melody Horn <melody@boringcactus.com> | 2020-10-28 17:01:55 -0600 |
commit | edf87f09045e8f56576b37078b4a0d220d6ddf55 (patch) | |
tree | 4503afb80ee7ea068db257c6381541a5fe1f716b /conf.py | |
parent | 72e8cabe8e3c8ae272fb4771f0d1dabb306dc2ae (diff) | |
download | spec-edf87f09045e8f56576b37078b4a0d220d6ddf55.tar.gz spec-edf87f09045e8f56576b37078b4a0d220d6ddf55.zip |
start using Sphinx for doc generation
Diffstat (limited to 'conf.py')
-rw-r--r-- | conf.py | 59 |
1 files changed, 59 insertions, 0 deletions
@@ -0,0 +1,59 @@ +# 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 = 'Crowbar language' +copyright = '2020 boringcactus (Melody Horn)' +author = 'boringcactus (Melody Horn)' + + +# -- 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 = [ + 'recommonmark', +] + +# 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'] + +latex_engine = 'xelatex' + + +# -- 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 = 'basic' + +# 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'] + +html_theme_options = { + "nosidebar": True, +} |