From 5ca492f07ad64804ae07c47f936c97434ae6a6b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Kl=C3=B6ckner?= Date: Mon, 4 Jan 2021 19:40:02 +0100 Subject: [PATCH] Shorten, standardize doc/conf --- doc/conf.py | 85 ++--------------------------------------------------- 1 file changed, 3 insertions(+), 82 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 64b4b77..8a6b0f4 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,22 +1,4 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- -# -# pudb documentation build configuration file, created by -# sphinx-quickstart on Wed Apr 5 16:44:29 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("..")) @@ -93,69 +75,8 @@ todo_include_todos = False # html_theme = "furo" -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 = "pudbdoc" - - -# -- 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, "pudb.tex", "pudb Documentation", - "Andreas Kloeckner and contributors", "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, "pudb", "pudb Documentation", - [author], 1) -] - - -# -- Options for Texinfo output ------------------------------------------- +html_theme_options = {} -# 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, "pudb", "pudb Documentation", - author, "pudb", "One line description of project.", - "Miscellaneous"), -] +autoclass_content = "class" +autodoc_typehints = "description" -autoclass_content = "both" -- GitLab