Merge branch 'main' into bump-python

Author: orbeckst

CHANGELOG.md

@@ -19,17 +19,23 @@ The rules for this file:
 ## [Unreleased]
 
 ### Authors
+<!-- GitHub usernames of contributors to this release -->
 - IAlibay
+- lilyminium
 - orbeckst
 
 ### Reviewers
 <!-- GitHub usernames of reviewers of this release -->
+- IAlibay
+- orbeckst
 
 ### Added
 <!-- New added features -->
+- additional example text for unordered list (PR #83)
 
 ### Fixed
 <!-- Bug fixes -->
+- always add bullet for unordered list (#82)
 
 ### Changed
 - support Python 3.14

docs/numpydoc_example.py

@@ -9,8 +9,6 @@
 a line by itself, preferably preceded by a blank line.
 
 """
-from __future__ import absolute_import, division, print_function
-
 import os  # standard library imports first
 
 import matplotlib as mpl
@@ -128,3 +126,37 @@ def foo(var1, var2, *args, long_var_name="hi", **kwargs):
     # But for function, method and module, there should be no blank lines
     # after closing the docstring.
     pass
+
+
+
+class TestClassDocumentation:
+    """
+    This is an example docstring of a class.
+
+    Unordered list:
+
+    * multi-line
+      item 1
+    * item 2
+        * sub-item 3
+
+    .. note::
+        This is a note inside a class docstring.
+
+    Parameters
+    ----------
+    filename : str
+        The name of the file to be read.
+
+    """
+
+    def __init__(self, filename: str):
+        """Initialize the class.
+
+        Parameters
+        ----------
+        filename : str
+            The name of the file to be read.
+
+        """
+        self.filename = filename

mdanalysis_sphinx_theme/sass/material-content.scss

@@ -368,6 +368,7 @@ ol {
   li {
     margin-bottom: 0.5em;
     margin-left: px2em(20px);
+    list-style: disc;
 
     // Adjust for right-to-left languages
     [dir="rtl"] & {

pyproject.toml

@@ -29,7 +29,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
-    "Programming Language :: Python :: 3.14",    
+    "Programming Language :: Python :: 3.14",
 ]
 readme = {file = "README.md", content-type = "text/markdown"}
 requires-python = ">=3.11"

setup.py

@@ -48,7 +48,8 @@ def dynamic_author_list():
     out_path = current_dir / "mdanalysis_sphinx_theme" / "authors.py"
     author_lines = "\n".join([f'    u"{name}",' for name in authors])
     template = f"""\
-#-*- coding:utf-8 -*-
+# -*- coding:utf-8 -*-
+
 # This file is generated from the AUTHORS file during the installation process.
 # Do not edit it as your changes will be overwritten.
 __authors__ = [