Fix some Sphinx documentation errors

xolox · Sep 17, 2021 · 4e9e0f0 · 4e9e0f0
1 parent 761ede5
commit 4e9e0f0
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -35,7 +35,7 @@ order to avoid unexpected surprises.
    :members:
 
 :mod:`humanfriendly.case`
-------------------------
+-------------------------
 
 .. automodule:: humanfriendly.case
    :members:
@@ -50,7 +50,10 @@ order to avoid unexpected surprises.
 ---------------------------
 
 .. automodule:: humanfriendly.compat
-   :members: coerce_string, is_string, is_unicode, on_windows
+   :members: coerce_string, is_string, is_unicode, on_macos, on_windows
+
+.. The members above are defined explicitly so that Sphinx does not
+.. embed documentation for all of the standard library aliases.
 
 :mod:`humanfriendly.decorators`
 -------------------------------