Fix docs build warning about overriding file (#467)

evansd · Jan 28, 2023 · d9db9af · d9db9af
1 parent 8e5a0ed
commit d9db9af
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/docs/base.rst b/docs/base.rst
@@ -206,7 +206,7 @@ sub-classing WhiteNoise and setting the attributes directly.
     Note that WhiteNoise ships with its own default set of mimetypes and does
     not use the system-supplied ones (e.g. ``/etc/mime.types``). This ensures
     that it behaves consistently regardless of the environment in which it's
-    run.  View the defaults in the :file:`media_types.py
+    run.  View the defaults in the :ghfile:`media_types.py
     <whitenoise/media_types.py>` file.
 
     In addition to file extensions, mimetypes can be specified by supplying the entire

diff --git a/docs/conf.py b/docs/conf.py
@@ -126,4 +126,4 @@ def _get_version() -> str:
 
 git_tag = f"{version}" if version != "development" else "main"
 github_base_url = f"https://github.com/evansd/whitenoise/blob/{git_tag}/src/"
-extlinks = {"file": (github_base_url + "%s", "")}
+extlinks = {"ghfile": (github_base_url + "%s", "")}
diff --git a/docs/django.rst b/docs/django.rst
@@ -340,7 +340,7 @@ arguments upper-cased with a 'WHITENOISE\_' prefix.
     Note that WhiteNoise ships with its own default set of mimetypes and does
     not use the system-supplied ones (e.g. ``/etc/mime.types``). This ensures
     that it behaves consistently regardless of the environment in which it's
-    run.  View the defaults in the :file:`media_types.py
+    run.  View the defaults in the :ghfile:`media_types.py
     <whitenoise/media_types.py>` file.
 
     In addition to file extensions, mimetypes can be specified by supplying the entire
@@ -424,7 +424,7 @@ arguments upper-cased with a 'WHITENOISE\_' prefix.
 
 .. attribute:: WHITENOISE_IMMUTABLE_FILE_TEST
 
-    :default: See :file:`immutable_file_test <whitenoise/middleware.py#L134>` in source
+    :default: See :ghfile:`immutable_file_test <whitenoise/middleware.py#L134>` in source
 
     Reference to function, or string.