From 3755797d8a23bc785beac9d8e0e546aae7f4d098 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andreas=20Kl=C3=B6ckner?= <inform@tiker.net>
Date: Mon, 4 Jan 2021 19:42:51 +0100
Subject: [PATCH] Shorten, standardize doc/conf
---
doc/conf.py | 109 ++--------------------------------------------------
1 file changed, 3 insertions(+), 106 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index c02a260..abf16aa 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -1,36 +1,3 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-#
-# pytools documentation build configuration file, created by
-# sphinx-quickstart on Wed Jun 14 16:28:43 2017.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
-
-# 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('.'))
-
-
-# -- General configuration ------------------------------------------------
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = "1.0"
-
-# 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.doctest",
"sphinx.ext.intersphinx",
@@ -38,7 +5,6 @@ extensions = ["sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx_copybutton",
]
-autoclass_content = "class"
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
@@ -94,81 +60,12 @@ todo_include_todos = False
#
html_theme = "furo"
-html_theme_options = {
- }
-
-# 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.
-#
-# html_theme_options = {}
-
-# 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']
-
-
-# -- Options for HTMLHelp output ------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "pytoolsdoc"
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
- # The paper size ("letterpaper" or "a4paper").
- #
- # "papersize": "letterpaper",
-
- # The font size ("10pt", "11pt" or "12pt").
- #
- # "pointsize": "10pt",
-
- # 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 = [
- (master_doc, "pytools.tex", "pytools Documentation",
- "Andreas Kloeckner", "manual"),
-]
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- (master_doc, "pytools", "pytools Documentation",
- [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 = [
- (master_doc, "pytools", "pytools Documentation",
- author, "pytools", "One line description of project.",
- "Miscellaneous"),
-]
-
-
intersphinx_mapping = {
"https://docs.python.org/3": None,
"https://numpy.org/doc/stable": None,
"https://documen.tician.de/pymbolic/": None,
"https://documen.tician.de/loopy/": None,
}
+
+autoclass_content = "class"
+autodoc_typehints = "description"
--
GitLab