89 lines
2.4 KiB
Python
89 lines
2.4 KiB
Python
# 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 = 'JMK Engineering Report Template'
|
|
copyright = '2023, Jeff MacKinnon'
|
|
author = 'Jeff MacKinnon'
|
|
release = 'A'
|
|
|
|
|
|
# -- 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_design",
|
|
# "myst_nb",
|
|
# "myst-parser",
|
|
]
|
|
source_suffix = {
|
|
'.rst': 'restructuredtext',
|
|
'.ipynb': 'myst-nb',
|
|
'.myst': 'myst-nb',
|
|
}
|
|
|
|
|
|
# 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 = 'alabaster'
|
|
html_theme = "sphinx_book_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']
|
|
|
|
|
|
|
|
|
|
# Latex setup
|
|
|
|
PREAMBLE = r"""
|
|
\usepackage{jmk}
|
|
"""
|
|
latex_additional_files = [
|
|
'_static/JMKEngineering-Logo.jpg',
|
|
'_static/JMKEngineering-Logo_text.jpg',
|
|
'_static/jmk.sty',
|
|
|
|
]
|
|
|
|
latex_elements = {
|
|
'pointsize':'12pt',
|
|
'classoptions': ',openany,oneside',
|
|
'preamble' : PREAMBLE,
|
|
'extrapackages': r'\usepackage{lipsum}',
|
|
}
|
|
|
|
latex_logo = '_static/logo.jpg'
|
|
|
|
latex_show_urls = 'inline'
|