Merge pull request #104 from bckohan/v2.x.x

move to furo theme from sphinx rtd theme

Author: bckohan

doc/source/conf.py

@@ -35,7 +35,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'django_typer'
+project = 'django-typer'
 copyright = f'2023-{datetime.now().year}, Brian Kohan'
 author = 'Brian Kohan'
 
@@ -69,7 +69,14 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+# html_theme = 'sphinx_rtd_theme'
+html_theme = 'furo'
+html_theme_options = {
+    "source_repository": "https://github.com/bckohan/django-typer/",
+    "source_branch": "main",
+    "source_directory": "doc/source",
+}
+html_title = f"{project} {release}"
 
 # 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,

doc/source/index.rst

@@ -141,7 +141,6 @@ Commands with multiple subcommands can be defined:
 
 |
 
-
 :big:`Grouping and Hierarchies Example`
 
 Or more complex groups and subcommand hierarchies can be defined. For example this command

examples/completers/management/commands/app_labels.py

@@ -28,7 +28,8 @@ def handle(
             t.List[str],
             typer.Argument(
                 help="The app label",
-                shell_complete=complete_app_label,  # pass the completer function here
+                # pass the completer function here
+                shell_complete=complete_app_label,
             ),
         ],
     ):

examples/completers/management/commands/app_labels_typer.py

@@ -28,7 +28,8 @@ def handle(
         t.List[str],
         typer.Argument(
             help="The app label",
-            shell_complete=complete_app_label,  # pass the completer function here
+            # pass the completer function here
+            shell_complete=complete_app_label,
         ),
     ],
 ):

pyproject.toml

@@ -91,6 +91,7 @@ pyright = "^1.1.357"
 ruff = "^0.4.1"
 graphviz = "^0.20.3"
 sphinx-tabs = "^3.4.5"
+furo = "^2024.7.18"
 
 [tool.poetry.extras]
 rich = ["rich"]