Skip to content

Add django-admin role. #75

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add django-admin role. #75

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6e1b27
add django-admin crossreference
bckohan Jul 10, 2025
2399f31
use django-admin naming instead of django internal djadmin
bckohan Jul 10, 2025
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
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Improvements for the output of Sphinx's autodoc for Django classes:
* Add information about autogenerated methods
* Fix intersphinx mappings to Django modules
* Custom text roles to cross-reference the documentations of Django (``:setting:``,
``:templatetag:``, ``:templatefilter:``, ``:fieldlookup:``) and Sphinx (``:event:``,
``:templatetag:``, ``:templatefilter:``, ``:fieldlookup:``, ``:django-admin:``) and Sphinx (``:event:``,
``:confval:``)


Expand Down
8 changes: 7 additions & 1 deletion sphinxcontrib_django/roles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,13 @@ def setup(app: sphinx.application.Sphinx) -> dict:
app.connect("config-inited", add_default_intersphinx_mappings)

# Allow intersphinx mappings to custom Django roles
django_crossref_types = ["setting", "templatetag", "templatefilter", "fieldlookup"]
django_crossref_types = [
"setting",
"templatetag",
"templatefilter",
"fieldlookup",
"django-admin",
]
# Allow intersphinx mappings to custom Sphinx roles
sphinx_crossref_types = ["event", "confval"]

Expand Down
Loading