Jeff Epler
5a1101fc6c
|version| was substituted into the main document title, but version= was never set; the default was empty.
96 lines
3.1 KiB
Python
96 lines
3.1 KiB
Python
# ruff: noqa
|
|
# fmt: off
|
|
# 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
|
|
import pathlib
|
|
import subprocess
|
|
|
|
sys.path.insert(0, str(pathlib.Path(__file__).parent.parent))
|
|
sys.path.append(str(pathlib.Path(__file__).parent / "_ext"))
|
|
|
|
# Define the canonical URL if you are using a custom domain on Read the Docs
|
|
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
|
|
|
|
html_context = {}
|
|
# Tell Jinja2 templates the build is running on Read the Docs
|
|
if os.environ.get("READTHEDOCS", "") == "True":
|
|
html_context["READTHEDOCS"] = True
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'leapseconddata'
|
|
copyright = '2021-2024, Jeff Epler'
|
|
author = 'Jeff Epler'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
version = release = subprocess.check_output(["python", "-m", "setuptools_scm"], cwd="..", encoding="ascii").strip()
|
|
|
|
|
|
# -- 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.autodoc',
|
|
'sphinx.ext.intersphinx',
|
|
'sphinx.ext.todo',
|
|
'custom_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', '_env', '.license']
|
|
|
|
# Show the contents of todo directives.
|
|
todo_include_todos = True
|
|
|
|
|
|
# -- 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']
|
|
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3", None),
|
|
}
|
|
|
|
autodoc_typehints = "description"
|
|
autodoc_typehints_format = "short"
|
|
autodoc_class_signature = "separated"
|
|
autodoc_default_options = {
|
|
"members": True,
|
|
"undoc-members": True,
|
|
"inherited-members": False,
|
|
"special-members": False,
|
|
"exclude-members": "__init__",
|
|
"show-inheritance": True,
|
|
}
|
|
autodoc_member_order = "bysource"
|
|
|
|
# SPDX-FileCopyrightText: 2021 Jeff Epler
|
|
#
|
|
# SPDX-License-Identifier: GPL-3.0-only
|