Skip to content

Improve Sphinx role usage, including linking Git manpages #1879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Mar 16, 2024
Next Next commit
Put Sphinx conf.py in the same style as other code
This is mostly a change to comments.
  • Loading branch information
EliahKagan committed Mar 15, 2024
commit 0969db92133e7562038275086ae560bda5b9d6e4
87 changes: 42 additions & 45 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,28 @@
#
# This file is execfile()d with the current directory set to its containing dir.
#
# The contents of this file are pickled, so don't put values in the namespace
# that aren't pickleable (module imports are okay, they're removed automatically).
# The contents of this file are pickled, so don't put values in the namespace that
# aren't pickleable (module imports are okay, they're removed automatically).
#
# Note that not all possible configuration values are present in this
# autogenerated file.
# 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.
# All configuration values have a default; values that are commented out serve to show
# the default.

import sys
import os
import sys

# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
# If your extensions are in another directory, add it here. If the directory is relative
# to the documentation root, use os.path.abspath to make it absolute, like shown here.
# sys.path.append(os.path.abspath('.'))
sys.path.insert(0, os.path.abspath("../.."))

# 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.
# 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"]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -44,9 +43,8 @@
project = "GitPython"
copyright = "Copyright (C) 2008, 2009 Michael Trier and contributors, 2010-2015 Sebastian Thiel"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
# The version info for the project you're documenting, acts as replacement for |version|
# and |release|, also used in various other places throughout the built documents.
#
# The short X.Y version.
with open(os.path.join(os.path.dirname(__file__), "..", "..", "VERSION")) as fd:
Expand All @@ -55,8 +53,8 @@
# The full version, including alpha/beta/rc tags.
release = VERSION

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# The language for content autogenerated by Sphinx. Refer to documentation for a list of
# supported languages.
# language = None

# There are two options for replacing |today|: either, you set today to some
Expand All @@ -68,8 +66,8 @@
# List of documents that shouldn't be included in the build.
# unused_docs = []

# List of directories, relative to source directory, that shouldn't be searched
# for source files.
# List of directories, relative to source directory, that shouldn't be searched for
# source files.
exclude_trees = ["build"]

# The reST default role (used for this markup: `text`) to use for all documents.
Expand All @@ -78,12 +76,12 @@
# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# If true, the current module name will be prepended to all description unit titles
# (such as .. function::).
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# If true, sectionauthor and moduleauthor directives will be shown in the output.
# They are ignored by default.
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
Expand All @@ -96,40 +94,39 @@
html_theme = "sphinx_rtd_theme"
html_theme_options = {}

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# The name for this set of Sphinx documents.
# If None, it defaults to "<project> v<release> documentation".
# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# The name of an image file (relative to this directory) to place at the top of the
# sidebar.
# html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# The name of an image file (within the static path) to use as favicon of the docs.
# This file should be a Windows icon file (.ico) being 16x16 or 32x32 pixels large.
# html_favicon = None

# 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".
# 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 = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, using the
# given strftime format.
# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# If true, SmartyPants will be used to convert quotes and dashes to typographically
# correct entities.
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
# Additional templates that should be rendered to pages, maps page names to template
# names.
# html_additional_pages = {}

# If false, no module index is generated.
Expand All @@ -144,9 +141,9 @@
# If true, the reST sources are included in the HTML build as _sources/<name>.
# html_copy_source = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# If true, an OpenSearch description file will be output, and all pages will contain a
# <link> tag referring to it. The value of this option must be the base URL from which
# the finished HTML is served.
# html_use_opensearch = ''

# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
Expand All @@ -171,8 +168,8 @@
("index", "GitPython.tex", "GitPython Documentation", "Michael Trier", "manual"),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
# The name of an image file (relative to this directory) to place at the top of the
# title page.
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
Expand Down