Commit 0a609b9
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3,29 +3,28 @@ | |||
| 3 | 3 | # | |
| 4 | 4 | # This file is execfile()d with the current directory set to its containing dir. | |
| 5 | 5 | # | |
| 6 | - # The contents of this file are pickled, so don't put values in the namespace | ||
| 7 | - # that aren't pickleable (module imports are okay, they're removed automatically). | ||
| 6 | + # The contents of this file are pickled, so don't put values in the namespace that | ||
| 7 | + # aren't pickleable (module imports are okay, they're removed automatically). | ||
| 8 | 8 | # | |
| 9 | - # Note that not all possible configuration values are present in this | ||
| 10 | - # autogenerated file. | ||
| 9 | + # Note that not all possible configuration values are present in this autogenerated | ||
| 10 | + # file. | ||
| 11 | 11 | # | |
| 12 | - # All configuration values have a default; values that are commented out | ||
| 13 | - # serve to show the default. | ||
| 12 | + # All configuration values have a default; values that are commented out serve to show | ||
| 13 | + # the default. | ||
| 14 | 14 | ||
| 15 | - import sys | ||
| 16 | 15 | import os | |
| 16 | + import sys | ||
| 17 | 17 | ||
| 18 | - # If your extensions are in another directory, add it here. If the directory | ||
| 19 | - # is relative to the documentation root, use os.path.abspath to make it | ||
| 20 | - # absolute, like shown here. | ||
| 18 | + # If your extensions are in another directory, add it here. If the directory is relative | ||
| 19 | + # to the documentation root, use os.path.abspath to make it absolute, like shown here. | ||
| 21 | 20 | # sys.path.append(os.path.abspath('.')) | |
| 22 | 21 | sys.path.insert(0, os.path.abspath("../..")) | |
| 23 | 22 | ||
| 24 | 23 | # General configuration | |
| 25 | 24 | # --------------------- | |
| 26 | 25 | ||
| 27 | - # Add any Sphinx extension module names here, as strings. They can be extensions | ||
| 28 | - # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
| 26 | + # Add any Sphinx extension module names here, as strings. They can be extensions coming | ||
| 27 | + # with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
| 29 | 28 | extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest"] | |
| 30 | 29 | ||
| 31 | 30 | # Add any paths that contain templates here, relative to this directory. | |
@@ -44,9 +43,8 @@ | |||
| 44 | 43 | project = "GitPython" | |
| 45 | 44 | copyright = "Copyright (C) 2008, 2009 Michael Trier and contributors, 2010-2015 Sebastian Thiel" | |
| 46 | 45 | ||
| 47 | - # The version info for the project you're documenting, acts as replacement for | ||
| 48 | - # |version| and |release|, also used in various other places throughout the | ||
| 49 | - # built documents. | ||
| 46 | + # The version info for the project you're documenting, acts as replacement for |version| | ||
| 47 | + # and |release|, also used in various other places throughout the built documents. | ||
| 50 | 48 | # | |
| 51 | 49 | # The short X.Y version. | |
| 52 | 50 | with open(os.path.join(os.path.dirname(__file__), "..", "..", "VERSION")) as fd: | |
@@ -55,8 +53,8 @@ | |||
| 55 | 53 | # The full version, including alpha/beta/rc tags. | |
| 56 | 54 | release = VERSION | |
| 57 | 55 | ||
| 58 | - # The language for content autogenerated by Sphinx. Refer to documentation | ||
| 59 | - # for a list of supported languages. | ||
| 56 | + # The language for content autogenerated by Sphinx. Refer to documentation for a list of | ||
| 57 | + # supported languages. | ||
| 60 | 58 | # language = None | |
| 61 | 59 | ||
| 62 | 60 | # There are two options for replacing |today|: either, you set today to some | |
@@ -68,8 +66,8 @@ | |||
| 68 | 66 | # List of documents that shouldn't be included in the build. | |
| 69 | 67 | # unused_docs = [] | |
| 70 | 68 | ||
| 71 | - # List of directories, relative to source directory, that shouldn't be searched | ||
| 72 | - # for source files. | ||
| 69 | + # List of directories, relative to source directory, that shouldn't be searched for | ||
| 70 | + # source files. | ||
| 73 | 71 | exclude_trees = ["build"] | |
| 74 | 72 | ||
| 75 | 73 | # The reST default role (used for this markup: `text`) to use for all documents. | |
@@ -78,58 +76,59 @@ | |||
| 78 | 76 | # If true, '()' will be appended to :func: etc. cross-reference text. | |
| 79 | 77 | # add_function_parentheses = True | |
| 80 | 78 | ||
| 81 | - # If true, the current module name will be prepended to all description | ||
| 82 | - # unit titles (such as .. function::). | ||
| 79 | + # If true, the current module name will be prepended to all description unit titles | ||
| 80 | + # (such as .. function::). | ||
| 83 | 81 | # add_module_names = True | |
| 84 | 82 | ||
| 85 | - # If true, sectionauthor and moduleauthor directives will be shown in the | ||
| 86 | - # output. They are ignored by default. | ||
| 83 | + # If true, sectionauthor and moduleauthor directives will be shown in the output. | ||
| 84 | + # They are ignored by default. | ||
| 87 | 85 | # show_authors = False | |
| 88 | 86 | ||
| 89 | 87 | # The name of the Pygments (syntax highlighting) style to use. | |
| 90 | 88 | pygments_style = "sphinx" | |
| 91 | 89 | ||
| 90 | + manpages_url = "https://git-scm.com/docs/{page}" | ||
| 91 | + | ||
| 92 | 92 | ||
| 93 | 93 | # Options for HTML output | |
| 94 | 94 | # ----------------------- | |
| 95 | 95 | ||
| 96 | 96 | html_theme = "sphinx_rtd_theme" | |
| 97 | 97 | html_theme_options = {} | |
| 98 | 98 | ||
| 99 | - # The name for this set of Sphinx documents. If None, it defaults to | ||
| 100 | - # "<project> v<release> documentation". | ||
| 99 | + # The name for this set of Sphinx documents. | ||
| 100 | + # If None, it defaults to "<project> v<release> documentation". | ||
| 101 | 101 | # html_title = None | |
| 102 | 102 | ||
| 103 | - # A shorter title for the navigation bar. Default is the same as html_title. | ||
| 103 | + # A shorter title for the navigation bar. Default is the same as html_title. | ||
| 104 | 104 | # html_short_title = None | |
| 105 | 105 | ||
| 106 | - # The name of an image file (relative to this directory) to place at the top | ||
| 107 | - # of the sidebar. | ||
| 106 | + # The name of an image file (relative to this directory) to place at the top of the | ||
| 107 | + # sidebar. | ||
| 108 | 108 | # html_logo = None | |
| 109 | 109 | ||
| 110 | - # The name of an image file (within the static path) to use as favicon of the | ||
| 111 | - # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
| 112 | - # pixels large. | ||
| 110 | + # The name of an image file (within the static path) to use as favicon of the docs. | ||
| 111 | + # This file should be a Windows icon file (.ico) being 16x16 or 32x32 pixels large. | ||
| 113 | 112 | # html_favicon = None | |
| 114 | 113 | ||
| 115 | - # Add any paths that contain custom static files (such as style sheets) here, | ||
| 116 | - # relative to this directory. They are copied after the builtin static files, | ||
| 117 | - # so a file named "default.css" will overwrite the builtin "default.css". | ||
| 114 | + # Add any paths that contain custom static files (such as style sheets) here, relative | ||
| 115 | + # to this directory. They are copied after the builtin static files, so a file named | ||
| 116 | + # "default.css" will overwrite the builtin "default.css". | ||
| 118 | 117 | html_static_path = [] | |
| 119 | 118 | ||
| 120 | - # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||
| 121 | - # using the given strftime format. | ||
| 119 | + # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, using the | ||
| 120 | + # given strftime format. | ||
| 122 | 121 | # html_last_updated_fmt = '%b %d, %Y' | |
| 123 | 122 | ||
| 124 | - # If true, SmartyPants will be used to convert quotes and dashes to | ||
| 125 | - # typographically correct entities. | ||
| 123 | + # If true, SmartyPants will be used to convert quotes and dashes to typographically | ||
| 124 | + # correct entities. | ||
| 126 | 125 | # html_use_smartypants = True | |
| 127 | 126 | ||
| 128 | 127 | # Custom sidebar templates, maps document names to template names. | |
| 129 | 128 | # html_sidebars = {} | |
| 130 | 129 | ||
| 131 | - # Additional templates that should be rendered to pages, maps page names to | ||
| 132 | - # template names. | ||
| 130 | + # Additional templates that should be rendered to pages, maps page names to template | ||
| 131 | + # names. | ||
| 133 | 132 | # html_additional_pages = {} | |
| 134 | 133 | ||
| 135 | 134 | # If false, no module index is generated. | |
@@ -144,9 +143,9 @@ | |||
| 144 | 143 | # If true, the reST sources are included in the HTML build as _sources/<name>. | |
| 145 | 144 | # html_copy_source = True | |
| 146 | 145 | ||
| 147 | - # If true, an OpenSearch description file will be output, and all pages will | ||
| 148 | - # contain a <link> tag referring to it. The value of this option must be the | ||
| 149 | - # base URL from which the finished HTML is served. | ||
| 146 | + # If true, an OpenSearch description file will be output, and all pages will contain a | ||
| 147 | + # <link> tag referring to it. The value of this option must be the base URL from which | ||
| 148 | + # the finished HTML is served. | ||
| 150 | 149 | # html_use_opensearch = '' | |
| 151 | 150 | ||
| 152 | 151 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). | |
@@ -171,8 +170,8 @@ | |||
| 171 | 170 | ("index", "GitPython.tex", "GitPython Documentation", "Michael Trier", "manual"), | |
| 172 | 171 | ] | |
| 173 | 172 | ||
| 174 | - # The name of an image file (relative to this directory) to place at the top of | ||
| 175 | - # the title page. | ||
| 173 | + # The name of an image file (relative to this directory) to place at the top of the | ||
| 174 | + # title page. | ||
| 176 | 175 | # latex_logo = None | |
| 177 | 176 | ||
| 178 | 177 | # For "manual" documents, if this is true, then toplevel headings are parts, | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -901,7 +901,8 @@ def working_dir(self) -> Union[None, PathLike]: | |||
| 901 | 901 | def version_info(self) -> Tuple[int, ...]: | |
| 902 | 902 | """ | |
| 903 | 903 | :return: Tuple with integers representing the major, minor and additional | |
| 904 | - version numbers as parsed from ``git version``. Up to four fields are used. | ||
| 904 | + version numbers as parsed from :manpage:`git-version(1)`. Up to four fields | ||
| 905 | + are used. | ||
| 905 | 906 | ||
| 906 | 907 | This value is generated on demand and is cached. | |
| 907 | 908 | """ | |
@@ -1038,9 +1039,9 @@ def execute( | |||
| 1038 | 1039 | 3. Deeper descendants do not receive signals, though they may sometimes | |
| 1039 | 1040 | terminate as a consequence of their parent processes being killed. | |
| 1040 | 1041 | 4. `kill_after_timeout` uses ``SIGKILL``, which can have negative side | |
| 1041 | - effects on a repository. For example, stale locks in case of ``git gc`` | ||
| 1042 | - could render the repository incapable of accepting changes until the lock | ||
| 1043 | - is manually removed. | ||
| 1042 | + effects on a repository. For example, stale locks in case of | ||
| 1043 | + :manpage:`git-gc(1)` could render the repository incapable of accepting | ||
| 1044 | + changes until the lock is manually removed. | ||
| 1044 | 1045 | ||
| 1045 | 1046 | :param with_stdout: | |
| 1046 | 1047 | If ``True``, default ``True``, we open stdout on the created process. | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -270,7 +270,7 @@ def get_config_path(config_level: Lit_config_levels) -> str: | |||
| 270 | 270 | class GitConfigParser(cp.RawConfigParser, metaclass=MetaParserBuilder): | |
| 271 | 271 | """Implements specifics required to read git style configuration files. | |
| 272 | 272 | ||
| 273 | - This variation behaves much like the ``git config`` command, such that the | ||
| 273 | + This variation behaves much like the :manpage:`git-config(1)` command, such that the | ||
| 274 | 274 | configuration will be read on demand based on the filepath given during | |
| 275 | 275 | initialization. | |
| 276 | 276 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -59,7 +59,7 @@ def partial_to_complete_sha_hex(self, partial_hexsha: str) -> bytes: | |||
| 59 | 59 | :raise gitdb.exc.BadObject: | |
| 60 | 60 | ||
| 61 | 61 | :note: | |
| 62 | - Currently we only raise :class:`~gitdb.exc.BadObject` as git does not | ||
| 62 | + Currently we only raise :exc:`~gitdb.exc.BadObject` as git does not | ||
| 63 | 63 | communicate ambiguous objects separately. | |
| 64 | 64 | """ | |
| 65 | 65 | try: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -222,8 +222,8 @@ def diff( | |||
| 222 | 222 | to be read and diffed. | |
| 223 | 223 | ||
| 224 | 224 | :param kwargs: | |
| 225 | - Additional arguments passed to ``git diff``, such as ``R=True`` to swap both | ||
| 226 | - sides of the diff. | ||
| 225 | + Additional arguments passed to :manpage:`git-diff(1)`, such as ``R=True`` to | ||
| 226 | + swap both sides of the diff. | ||
| 227 | 227 | ||
| 228 | 228 | :return: | |
| 229 | 229 | A :class:`DiffIndex` representing the computed diff. | |
@@ -590,7 +590,7 @@ def _index_from_patch_format(cls, repo: "Repo", proc: Union["Popen", "Git.AutoIn | |||
| 590 | 590 | The repository we are operating on. | |
| 591 | 591 | ||
| 592 | 592 | :param proc: | |
| 593 | - ``git diff`` process to read from | ||
| 593 | + :manpage:`git-diff(1)` process to read from | ||
| 594 | 594 | (supports :class:`Git.AutoInterrupt <git.cmd.Git.AutoInterrupt>` wrapper). | |
| 595 | 595 | ||
| 596 | 596 | :return: | |
0 commit comments