From 33c3f146072b832430ab3e431d8695617928d553 Mon Sep 17 00:00:00 2001 From: Cheng Gong Date: Wed, 10 Apr 2024 17:31:09 -0400 Subject: [PATCH] add a few more settings for sphinx --- docs/conf.py | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1c0b394..bb36a9a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,5 @@ # Configuration file for the Sphinx documentation builder. -#from importlib.metadata import version +from importlib.metadata import version # -- Project information @@ -8,19 +8,22 @@ author = 'Cheng Gong' # The short X.Y version -#version = version("PINNICLE") +version = version("pinnicle") version = '0.1' # The full version, including alpha/beta/rc tags release = version # -- General configuration - extensions = [ 'sphinx.ext.duration', 'sphinx.ext.doctest', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx', + 'sphinx.ext.mathjax', + 'sphinx.ext.viewcode', + 'sphinx.ext.napoleon', + 'sphinx_copybutton', ] intersphinx_mapping = { @@ -37,3 +40,13 @@ # -- Options for HTML output html_theme = 'sphinx_rtd_theme' +# The suffix(es) of source filenames. +source_suffix = ".rst" + +# 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"] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx"