🎨 logo 2024

.readthedocs.yaml

@@ -7,6 +7,6 @@ sphinx:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-   version: 3.8
+   version: 3.10
    install:
-   - requirements: requirements.txt
+   - requirements: requirements_docs.txt

docs/conf.py

@@ -12,18 +12,36 @@
 #
 import os
 import sys
-from mock import Mock as MagicMock
+
 import sphinx_rtd_theme
 
+sys.path.append(os.path.join(os.path.dirname(__file__), ".."))
+try:
+    from ash_model import __version__
+except ImportError:
+    __version__ = u'0.1.0'
+
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
-class Mock(MagicMock):
-    @classmethod
-    def __getattr__(cls, name):
-        return MagicMock()
+version = __version__
+# The full version, including alpha/beta/rc tags.
+release = version
 
+html_theme_options = {
+    "collapse_navigation": False,
+    "display_version": False,
+    "navigation_depth": 3,
+}
+
+# -- Project information -----------------------------------------------------
 
-MOCK_MODULES = [
-    "numpy",
+project = "ASH"
+copyright = "2024, Giulio Rossetti"
+author = "Giulio Rossetti, Andrea Failla, Salvatore Citraro"
+
+autodoc_mock_imports = [
+     "numpy",
     "halp.undirected_hypergraph",
     "halp.utilities.undirected_matrices",
     "matplotlib.pyplot",
@@ -37,21 +55,7 @@ def __getattr__(cls, name):
     "tqdm",
     "seaborn",
     "pandas",
-
 ]
-sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
-
-
-sys.path.insert(0, os.path.abspath('../'))
-
-# -- Project information -----------------------------------------------------
-
-project = 'ASH'
-copyright = '2023, Giulio Rossetti'
-author = 'Giulio Rossetti, Andrea Failla, Salvatore Citraro'
-
-# The full version, including alpha/beta/rc tags
-release = '0.1.0'
 
 # -- General configuration ---------------------------------------------------
 
@@ -61,29 +65,34 @@ def __getattr__(cls, name):
 extensions = [
     "sphinx.ext.mathjax",
     "sphinx.ext.githubpages",
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
 ]
 
+
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-import sphinx_rtd_theme
+# html_theme = 'alabaster'
+
+html_logo = 'ash.png'
+
+# The name of an image file (relative to this directory) to use as a favicon of
+# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
 
-html_theme = 'sphinx_rtd_theme'
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-#html_context = {"css_files": ["_static/css/custom.css"]}

requirements_docs.txt

@@ -0,0 +1,9 @@
+halp
+numpy
+scipy
+networkx
+matplotlib
+seaborn
+pandas
+tqdm
+sphinx_rtd_theme