Updates for documentation generation

thomas-robinson · thomas-robinson · commit 489a5415f756 · 2025-06-03T07:07:07.000-04:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -12,6 +12,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
+    'sphinx_autodoc_typehints',  # optional, if you want type hints shown nicely
 ]
 
 project = 'chatfrecli'
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,11 +6,6 @@
 chatfrecli documentation
 ========================
 
-Add your content using ``reStructuredText`` syntax. See the
-`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
-documentation for details.
-
-
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
@@ -21,3 +16,4 @@ documentation for details.
    :members:
    :undoc-members:
    :show-inheritance:
+

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`extensions = [`
`13`	`13`	`'sphinx.ext.autodoc',`
`14`	`14`	`'sphinx.ext.napoleon',`
	`15`	`+ 'sphinx_autodoc_typehints', # optional, if you want type hints shown nicely`
`15`	`16`	`]`
`16`	`17`
`17`	`18`	`project = 'chatfrecli'`