Skip to content

Commit

Permalink
upadted the docs logo
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandrequ committed Jun 24, 2024
1 parent 6a1d031 commit 9513fdd
Showing 1 changed file with 44 additions and 21 deletions.
65 changes: 44 additions & 21 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
import sys, os
from unittest import mock
sys.path.insert(0, os.path.abspath('../..'))

sys.path.insert(0, os.path.abspath("../.."))

# run api-doc in terminal
os.system("sphinx-apidoc -fMT ../../arcjetCV -o api --templatedir=template -e")

project = 'arcjetCV'
author = 'arcjetCV Team'
project = "arcjetCV"
author = "arcjetCV Team"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
'myst_parser',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'nbsphinx',
'nbsphinx_link',
"myst_parser",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"nbsphinx",
"nbsphinx_link",
]

# avoid running the notebook's cells
nbsphinx_execute = 'never'
nbsphinx_execute = "never"

myst_enable_extensions = [
"dollarmath",
Expand All @@ -37,25 +38,47 @@
"tasklist",
]

templates_path = ['_templates']
templates_path = ["_templates"]
exclude_patterns = []

language = 'python'
language = "python"

exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '**.ipynb_checkpoints']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]

MOCK_MODULES = ['matplotlib', 'matplotlib.backends', 'matplotlib.backends.backend_qt5agg', 'matplotlib.figure', 'matplotlib.pyplot', 'matplotlib.colors', 'matplotlib.widgets',
'PySide6', 'PySide6.QtWidgets', 'PySide6.QtGui', 'PySide6.QtCore', 'cv2', 'numpy', 'pandas', 'pyarrow', 'sklearn', 'sklearn.neighbors', 'scipy',
'segmentation-models-pytorch', 'torch', 'torch.nn', 'torch.nn.functional', 'torchvision']
MOCK_MODULES = [
"matplotlib",
"matplotlib.backends",
"matplotlib.backends.backend_qt5agg",
"matplotlib.figure",
"matplotlib.pyplot",
"matplotlib.colors",
"matplotlib.widgets",
"PySide6",
"PySide6.QtWidgets",
"PySide6.QtGui",
"PySide6.QtCore",
"cv2",
"numpy",
"pandas",
"pyarrow",
"sklearn",
"sklearn.neighbors",
"scipy",
"segmentation-models-pytorch",
"torch",
"torch.nn",
"torch.nn.functional",
"torchvision",
]
for module_name in MOCK_MODULES:
sys.modules[module_name] = mock.Mock()

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'sphinx_rtd_theme'
html_logo = "../../arcjetCV/gui/logo/arcjetCV_logo_white.png"
html_theme = "sphinx_rtd_theme"
html_logo = "../../arcjetCV/gui/logo/arcjetCV_logo_.png"
html_theme_options = {
'logo_only': True,
'display_version': False,
"logo_only": True,
"display_version": False,
}

0 comments on commit 9513fdd

Please sign in to comment.