Skip to content

Commit

Permalink
improve config file
Browse files Browse the repository at this point in the history
related to #41
  • Loading branch information
abearab committed Apr 6, 2024
1 parent 72622aa commit 127dd6b
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

# -- General configuration ---------------------------------------------

# https://brendanhasz.github.io/2019/01/05/sphinx.html

# General information about the project.
project = 'ScreenPro2'
author = "ScreenPro2 Development Team"
Expand Down Expand Up @@ -66,12 +68,18 @@
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False

# Enabling napoleon
napoleon_google_docstring = True
napoleon_numpy_docstring = False

extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.intersphinx',
"sphinx.ext.extlinks",
'sphinx.ext.viewcode',
'myst_parser',
"sphinxcontrib.bibtex",
"sphinx.ext.extlinks",
'myst_parser',
]

# -- Options for HTML output -------------------------------------------
Expand Down Expand Up @@ -119,7 +127,7 @@
latex_documents = [
(master_doc, 'screenpro.tex',
'ScreenPro2 Documentation',
'Abolfazl Arab',
'ScreenPro2 Development Team',
'manual'),
]

Expand All @@ -142,6 +150,10 @@
)
]

intersphinx_mapping = {
'anndata': ('https://anndata.readthedocs.io/en/latest/', None)
}

# extlinks config
extlinks = {
"issue": ("https://github.com/scverse/scanpy/issues/%s", "issue%s"),
Expand Down

0 comments on commit 127dd6b

Please sign in to comment.