docs/source/conf.py

   1 # Configuration file for the Sphinx documentation builder.
   2 #
   3 # For the full list of built-in configuration values, see the documentation:
   4 # https://www.sphinx-doc.org/en/master/usage/configuration.html
   5
   6 # -- Project information -----------------------------------------------------
   7 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
   8
   9 project = 'MACS3'
  10 copyright = '2024, Tao Liu, Philippa Doherty'
  11 author = 'Tao Liu, Philippa Doherty'
  12 release = '3.0.1'
  13
  14 # -- General configuration ---------------------------------------------------
  15 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
  16
  17 extensions = [
  18     'myst_parser',
  19     'sphinx.ext.autodoc',
  20     'sphinx.ext.viewcode',
  21     'sphinx.ext.mathjax',
  22     'sphinx.ext.githubpages'
  23     ]
  24
  25 myst_enable_extensions = [
  26     "dollarmath",
  27     "amsmath",
  28 ]
  29
  30 templates_path = ['_templates']
  31 exclude_patterns = []
  32
  33 source_suffix = {
  34     '.rst': 'restructuredtext',
  35     '.md': 'markdown',
  36 }
  37
  38 # -- Options for HTML output -------------------------------------------------
  39 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
  40 html_theme = "sphinx_rtd_theme"
  41 html_static_path = ['_static']