Clean up docs

Author: earwig

.coveragerc

@@ -7,3 +7,4 @@ exclude_lines =
 	raise NotImplementedError()
 partial_branches =
     pragma: no branch
+    if TYPE_CHECKING:

docs/_static/.gitkeep

@@ -9,21 +9,21 @@ smart_list Package
     :undoc-members:
 
 :mod:`list_proxy` Module
----------------------
+------------------------
 
 .. automodule:: mwparserfromhell.smart_list.list_proxy
     :members:
     :undoc-members:
 
 :mod:`smart_list` Module
----------------------
+------------------------
 
 .. automodule:: mwparserfromhell.smart_list.smart_list
     :members:
     :undoc-members:
 
 :mod:`utils` Module
----------------------
+-------------------
 
 .. automodule:: mwparserfromhell.smart_list.utils
     :members:

docs/api/mwparserfromhell.smart_list.rst

@@ -41,7 +41,7 @@
 
 # General information about the project.
 project = "mwparserfromhell"
-copyright = "2012–2021 Ben Kurtovic"
+copyright = "2012–2025 Ben Kurtovic"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -91,12 +91,21 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "nature"
+html_theme = "alabaster"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-# html_theme_options = {}
+html_theme_options = {
+    "github_user": "earwig",
+    "github_repo": "mwparserfromhell",
+    "github_type": "star",
+    "description": "A parser for MediaWiki wikicode",
+    "show_relbars": True,
+    "page_width": "1200px",
+    "sidebar_width": "320px",
+    "fixed_sidebar": True,
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []

docs/conf.py

@@ -38,6 +38,7 @@ dev = [
     "psutil",
     "pytest",
     "pytest-cov",
+    "sphinx",
 ]
 
 [build-system]

pyproject.toml

@@ -364,11 +364,11 @@ def add(
 
     def update(self, params: Mapping[Any, Any], **kwargs: Any) -> None:
         """Update the template with multiple parameters at once.
-        Args:
-            params: A dictionary mapping parameter names to values.
-            **kwargs: Optional arguments that will be applied to all parameters,
-                matching the same arguments in :meth:`add` (showkey, before,
-                after, preserve_spacing)
+
+        - *params*: A dictionary mapping parameter names to values.
+        - *kwargs*: Optional arguments that will be applied to all parameters, matching
+          the same arguments in :meth:`add` (*showkey*, *before*, *after*,
+          *preserve_spacing*).
         """
         for name, value in params.items():
             self.add(name, value, **kwargs)