Improved documentation

AlessioNar · Dec 23, 2024 · c66ba03 · c66ba03
1 parent 297e11a
commit c66ba03
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 88 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -20,8 +20,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
-    'sphinx.ext.napoleon',  
-
+    'sphinx.ext.napoleon',  # Ensure napoleon extension is included for Google style docstrings
 ]
 
 intersphinx_mapping = {
@@ -38,4 +37,17 @@
 html_theme = 'sphinx_rtd_theme'
 
 # -- Options for EPUB output
-epub_show_urls = 'footnote'
+epub_show_urls = 'footnote'
+
+# -- Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -1,6 +1,8 @@
 Getting Started
 ===============
 
+.. _getting_started:
+
 Installation
 ------------
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,8 +4,7 @@ Welcome to tulit's documentation!
 **tulit** is a Python library for processing legal documents in various formats,
 including Akoma Ntoso and Formex.
 
-Check out the :doc:`getting started` section for further information, including
-how to :ref:`installation` the project.
+Check out the :doc:`getting started` section for further information.
 
 .. note::
 

diff --git a/docs/source/usage.rst b/docs/source/usage.rst