Diff of /doc/source/conf.py [000000] .. [7823dd]

Switch to side-by-side view

--- a
+++ b/doc/source/conf.py
@@ -0,0 +1,83 @@
+"""
+Sphinx configuration.
+
+*********************
+"""
+
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# 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 sphinx_rtd_theme
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'pathaia'
+copyright = '2020, arnaud abreu'
+author = 'arnaud abreu'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+extensions.append("sphinx.ext.autodoc")
+extensions.append("sphinx.ext.napoleon")
+extensions.append("sphinx_autodoc_typehints")
+
+add_module_names = False
+
+# Add any paths that contain templates here, relative to this directory.
+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 = []
+autodoc_member_order = 'bysource'
+autodoc_mock_imports = ["fastcore",
+                        "numpy",
+                        "tqdm",
+                        "openslide",
+                        "cv2",
+                        "skimage",
+                        "matplotlib",
+                        "nptyping",
+                        "pandas",
+                        "sklearn",
+                        "tensorflow"
+                        ]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'alabaster'
+
+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']