Skip to content

Commit

Permalink
add a few more settings for sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
enigne committed Apr 10, 2024
1 parent 0580f16 commit 33c3f14
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Configuration file for the Sphinx documentation builder.
#from importlib.metadata import version
from importlib.metadata import version

# -- Project information

Expand All @@ -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 = {
Expand All @@ -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"

0 comments on commit 33c3f14

Please sign in to comment.