docs(bff): add cast_to_category_pd into the doc

Correction of docstring for the `idict` function to have a better
display in the documentation.

bff/fancy.py

@@ -225,7 +225,9 @@ def get_peaks(s: pd.Series, distance_scale: float = 0.04):
 
 def idict(d: Dict[Any, Hashable]) -> Dict[Hashable, Any]:
     """
-    Invert a dictionary meaning that keys will be become values and values will become keys.
+    Invert a dictionary.
+
+    Keys will be become values and values will become keys.
 
     Parameters
     ----------

doc/README.md

@@ -1,13 +1,5 @@
 # Documentation
 
-## Generation of files for functions
-
-Run from source folder of doc:
-
-```sh
-sphinx-autogen -o generated *.rst
-```
-
 ## Generate the documentation
 
 ```sh

doc/source/conf.py

@@ -14,9 +14,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+#import os
+#import sys
+#sys.path.insert(0, os.path.abspath('.'))
 
 
 # -- Project information -----------------------------------------------------
@@ -40,11 +40,13 @@
 extensions = [
     'recommonmark',
     'sphinx.ext.autodoc',
-    'sphinx_autodoc_typehints',
-    'sphinx.ext.napoleon',  # Needed to separate type from variable name in docstrings.
+    'sphinx.ext.napoleon',      # Needed to separate type from variable name in docstrings.
+    'sphinx_autodoc_typehints', # Need to be imported after `sphinx.ext.napoleon`.
     'numpydoc',
 ]
 
+autosummary_generate = True     # Make _autosummary files and include them.
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

doc/source/fancy.rst

@@ -7,6 +7,7 @@ All of bff's functions.
    :nosignatures:
    :toctree: generated/
 
+   bff.cast_to_category_pd
    bff.concat_with_categories
    bff.get_peaks
    bff.idict