--- a +++ b/docs/conf.py @@ -0,0 +1,78 @@ +import os +import sys +import logging +from datetime import datetime +from pathlib import Path +from sphinx.ext import autosummary + +import matplotlib +matplotlib.use('agg') + +HERE = Path(__file__).parent +sys.path.insert(0, str(HERE.parent)) + +import multivelo + +# -- Project information + +project = 'MultiVelo' +copyright = f'{datetime.now():%Y}, Welch Lab' +author = 'Chen Li' + +release = '0.1' +version = '0.1.5' + +notebooks_url = "https://github.com/welch-lab/multivelo/raw/main/multivelo_demo/MultiVelo_Demo.ipynb" + +# -- General configuration + +extensions = [ + 'sphinx.ext.doctest', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', + 'sphinx.ext.githubpages', + 'nbsphinx', + 'nbsphinx_link' +] + +autosummary_generate = True +# Napoleon settings +napoleon_google_docstring = False +napoleon_numpy_docstring = True +napoleon_include_init_with_doc = False +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = False +napoleon_preprocess_types = False +napoleon_type_aliases = None +napoleon_attr_annotations = True + +html_theme = "sphinx_rtd_theme" +html_static_path = ['_static'] +html_css_files = [ + 'custom.css', +] + +intersphinx_mapping = { + 'python': ('https://docs.python.org/3/', None), + 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), +} +intersphinx_disabled_domains = ['std'] + +templates_path = ['_templates'] + +# -- Options for HTML output + +html_theme = 'sphinx_rtd_theme' + +# -- Options for EPUB output +epub_show_urls = 'footnote' + +suppress_warnings = ["config.cache"]