mirror of
https://github.com/wassname/greater_tables_project.git
synced 2026-06-27 16:15:38 +08:00
Stephen Mildenhall
111 lines
3.2 KiB
Python
111 lines
3.2 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 --------------------------------------------------------------
|
|
import pandas as pd
|
|
import greater_tables as gter
|
|
|
|
|
|
# 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('.'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = gter.__project__
|
|
copyright = '2025, Stephen J Mildenhall'
|
|
author = gter.__author__
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = gter.__version__
|
|
|
|
|
|
# -- 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.
|
|
# same as aggregate
|
|
extensions = [
|
|
'sphinx_rtd_theme',
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.mathjax',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.githubpages',
|
|
'sphinx.ext.autosectionlabel',
|
|
'sphinx_copybutton',
|
|
'sphinx_toggleprompt',
|
|
'IPython.sphinxext.ipython_directive',
|
|
'IPython.sphinxext.ipython_console_highlighting',
|
|
'nbsphinx',
|
|
'sphinx_panels',
|
|
'sphinxcontrib.bibtex',
|
|
'sphinx_multitoc_numbering',
|
|
'sphinx_rtd_dark_mode',
|
|
'myst_parser']
|
|
|
|
# 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']
|
|
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
|
|
# GPT suggestions for the reference problem
|
|
autonumbering_enabled = True
|
|
|
|
# bibtex options
|
|
bibtex_bibfiles = ['library.bib', 'books.bib']
|
|
bibtex_reference_style = 'author_year'
|
|
|
|
# user starts in light mode
|
|
default_dark_mode = False
|
|
|
|
|
|
# -- 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'
|
|
|
|
html_theme_options = {
|
|
'logo_only': False,
|
|
'display_version': True,
|
|
'prev_next_buttons_location': 'both',
|
|
'style_external_links': False,
|
|
'collapse_navigation': True,
|
|
'sticky_navigation': True,
|
|
'navigation_depth': 3,
|
|
'includehidden': True,
|
|
'titles_only': False,
|
|
}
|
|
|
|
html_logo = '_static/greater-tables-logo.png'
|
|
html_favicon = '_static/favicon.ico'
|
|
|
|
|
|
# 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']
|
|
|
|
# down the road - get tex docs from aggregate
|