fix(docs): Improve documentation (#77)

* First push * minor change
soda-inria · Nov 12, 2024 · 749467e · 749467e
1 parent 5e581d5
commit 749467e
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 8 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -1,7 +1,7 @@
 API
 ===
 
-This page lists all the public functions and classes of the `hazardous`
+This page lists all the public functions and classes of the ``hazardous``
 package:
 
 .. currentmodule:: hazardous

diff --git a/doc/conf.py b/doc/conf.py
@@ -15,11 +15,12 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    'sphinx_gallery.gen_gallery',
-    'sphinx.ext.autosummary',
+    "numpydoc",
+    "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
-    'numpydoc',
-    'sphinx_design',
+    "sphinx_design",
+    "sphinx_gallery.gen_gallery",
+    "sphinx_copybutton",
 ]
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
@@ -40,8 +41,17 @@
 
 # sphinx_gallery options
 sphinx_gallery_conf = {
-    'examples_dirs': '../examples',   # path to example scripts
-    'gallery_dirs': 'auto_examples',  # path to gallery generated output
+    "examples_dirs": "../examples",  # path to example scripts
+    "gallery_dirs": "auto_examples",  # path to gallery generated output
+    "within_subsection_order": "FileNameSortKey",  # See https://sphinx-gallery.github.io/stable/configuration.html#sorting-gallery-examples for alternatives
+    "show_memory": False,
+    "write_computation_times": False,
+    'reference_url': {
+        # Intersphinx links
+        # The module you locally document uses None
+        'hazardous': None,
+        }
+
 }
 
 # intersphinx configuration
@@ -57,4 +67,16 @@
     "announcement": (
         "https://raw.githubusercontent.com/soda-inria/hazardous/main/doc/announcement.html"
     ),
+        "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/soda-inria/hazardous/",
+            "icon": "fa-brands fa-github",
+        },
+    ],
+
 }
+
+# Sphinx-Copybutton configuration
+copybutton_prompt_text = r">>> |\.\.\. |\$ "
+copybutton_prompt_is_regexp = True
diff --git a/examples/README.rst b/examples/README.rst
@@ -1,5 +1,5 @@
 Examples
 ========
 
-Below is a gallery of examples on how to use `hazardous` for predictive
+Below is a gallery of examples on how to use ``hazardous`` for predictive
 competive risk analysis problems.
diff --git a/examples/plot_survival_analysis.py → examples/plot_01_survival_analysis.py b/examples/plot_survival_analysis.py → examples/plot_01_survival_analysis.py
diff --git a/...rginal_cumulative_incidence_estimation.py → ...rginal_cumulative_incidence_estimation.py b/...rginal_cumulative_incidence_estimation.py → ...rginal_cumulative_incidence_estimation.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -45,6 +45,7 @@ doc = [
     "pydata-sphinx-theme",
     "sphinx-gallery",
     "sphinx-design",
+    "sphinx-copybutton",
     "matplotlib",
     "pillow",  # to scrape images from the examples
     "numpydoc",