qmcpack/docs/conf.py

67 lines
2.5 KiB
Python

# 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 os
#import sys
#sys.path.insert(0, os.path.abspath('extensions'))
# -- Project information -----------------------------------------------------
project = 'QMCPACK Manual'
copyright = '2023, QMCPACK Developers'
author = 'QMCPACK Developers'
# The full version, including alpha/beta/rc tags
# -- 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.
import sys, os
sys.path.append(os.path.abspath('extensions'))
import sphinx_rtd_theme
extensions = ['sphinxcontrib.bibtex', "sphinx_rtd_theme"]
bibtex_bibfiles = ['bibs/running.bib', 'bibs/methods.bib', 'bibs/introduction.bib', 'bibs/afqmc.bib', 'bibs/intro_wavefunction.bib', 'bibs/spin-orbit.bib', 'bibs/hamiltonianobservable.bib', 'bibs/design_features.bib', 'bibs/lab_excited.bib', 'bibs/additional_tools.bib', 'bibs/developing.bib', 'bibs/labs_qmc_basics.bib', 'bibs/simulationcell.bib', 'bibs/features.bib', 'bibs/sCI.bib', 'bibs/LCAO.bib']
numfig = True
# 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 = ['_build', 'Thumbs.db', '.DS_Store']
# -- 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 = 'sphinx_rtd_theme'
# 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']
html_css_files = [
'custom.css',
]