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.

Sign up for GitHub

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
Merged

Improve Sphinx role usage, including linking Git manpages #1879

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0969db9
Put Sphinx conf.py in the same style as other code
EliahKagan Mar 15, 2024
c5a29a9
Link Sphinx manpage references to online Git docs
EliahKagan Mar 15, 2024
7f1675d
Remove a spurious extra backtick from a docstring
EliahKagan Mar 15, 2024
e883293
Add a missing Sphinx reference to a class
EliahKagan Mar 15, 2024
d8ab99c
Use Sphinx manpage references where applicable
EliahKagan Mar 15, 2024
d271a84
Use more official link to index-format documentation
EliahKagan Mar 15, 2024
ca95c42
Use current main official link to git-clone URLS doc
EliahKagan Mar 15, 2024
8543457
Use :const: for constants that had the :attr: role
EliahKagan Mar 15, 2024
6626117
Fix parse_date docstring spacing; use RFC role
EliahKagan Mar 16, 2024
a957ae7
Use the :exc: role for exceptions
EliahKagan Mar 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Use more official link to index-format documentation 
This could also be written automatically by labeling it with the
:manpage: role, but it doesn't seem to be an actual manpage, so I
have not done that.
  • Loading branch information
@EliahKagan
EliahKagan committed Mar 15, 2024
commit d271a84a67ab1cbb9c5922244fd5e17517520593
2 changes: 1 addition & 1 deletion git/index/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -862,7 +862,7 @@ def add(
handled manually at all.

All current built-in extensions are listed here:
http://opensource.apple.com/source/Git/Git-26/src/git-htmldocs/technical/index-format.txt
https://git-scm.com/docs/index-format

:return:
List of :class:`~git.index.typ.BaseIndexEntry`\s representing the entries
Expand Down