Improve Sphinx role usage, including linking Git manpages by EliahKagan · Pull Request #1879 · gitpython-developers/GitPython
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.
# 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:
# 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
# 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.
# 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. pygments_style = "sphinx"
manpages_url = "https://git-scm.com/docs/{page}"
# Options for HTML output # -----------------------
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.
# 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").
# 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,