ARDEN-documentation/conf.py

193 lines
5.8 KiB
Python
Raw Normal View History

2018-11-25 15:22:15 -07:00
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
2022-06-08 15:39:33 -06:00
from datetime import date
2018-11-25 15:22:15 -07:00
# -- Project information -----------------------------------------------------
2024-05-31 12:27:07 -06:00
project = u'AREDN® Documentation'
2022-06-08 15:39:33 -06:00
copyright = f'{date.today().year}, Amateur Radio Emergency Data Network, Inc. Licensed under the terms of Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International'
author = u'Amateur Radio Emergency Data Network, Inc.'
2018-11-25 15:22:15 -07:00
# The short X.Y version
2024-06-28 14:02:03 -06:00
version = u'latest'
2018-11-25 15:22:15 -07:00
# The full version, including alpha/beta/rc tags
2024-06-28 14:02:03 -06:00
release = u'latest'
2018-11-25 15:22:15 -07:00
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
#needs_sphinx = '5.3'
2018-11-25 15:22:15 -07:00
# 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',
]
2024-07-17 09:03:01 -06:00
###rst_epilog = """
###`Link: AREDN® Webpage <https://www.arednmesh.org>`_
###"""
# Include the trademark symbol in the prolog
2024-07-17 09:03:01 -06:00
###rst_prolog = """
###.. |trade| unicode:: U+00AE .. Registered Trademark SIGN
### :ltrim:
###
###"""
2018-11-25 15:22:15 -07:00
# Add any paths that contain templates here, relative to this directory.
#templates_path = ['_templates']
2018-11-25 15:22:15 -07:00
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
2023-05-07 17:06:42 -06:00
language = 'en'
2018-11-25 15:22:15 -07:00
# 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.
2022-06-12 20:37:07 -06:00
exclude_patterns = [u'_build', u'Thumbs.db', u'.DS_Store']
2018-11-25 15:22:15 -07:00
# The name of the Pygments (syntax highlighting) style to use.
2023-05-07 17:06:42 -06:00
pygments_style = 'sphinx'
2018-11-25 15:22:15 -07:00
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
2024-07-13 10:26:36 -06:00
html_theme = 'sphinx_book_theme'
2018-11-25 15:22:15 -07:00
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
2024-07-01 08:33:16 -06:00
html_logo = "_images/AREDN-Logo.png"
html_theme_options = {
'logo_only': True,
2024-07-13 10:26:36 -06:00
"toc_title": "Page Navigation",
"use_download_button": False,
2024-07-01 08:33:16 -06:00
}
2018-11-25 15:22:15 -07:00
# 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']
2018-11-25 15:22:15 -07:00
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'AREDN_Documentation'
2018-11-25 15:22:15 -07:00
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
'pointsize': '12pt',
2018-11-25 15:22:15 -07:00
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
2024-05-31 12:27:07 -06:00
(master_doc, 'AREDN_Documentation.tex', u'AREDN® Documentation',
2018-11-25 15:22:15 -07:00
u'AREDN', 'manual'),
]
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
2024-05-31 12:27:07 -06:00
(master_doc, 'aredn_documentation', u'AREDN® Documentation',
2018-11-25 15:22:15 -07:00
[author], 1)
]
# -- Options for Texinfo output ----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
2024-05-31 12:27:07 -06:00
(master_doc, 'AREDN_Documentation', u'AREDN® Documentation',
author, 'AREDN_Documentation', 'A guide for AREDN® software.',
2018-11-25 15:22:15 -07:00
'Miscellaneous'),
]
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''
# A unique identification for the text.
#
# epub_uid = ''
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Extension configuration -------------------------------------------------