mirror of
https://github.com/btcsuite/btcd.git
synced 2024-11-19 01:40:07 +01:00
78 lines
2.5 KiB
Python
78 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('.'))
|
||
|
|
import recommonmark
|
||
|
|
from recommonmark.transform import AutoStructify
|
||
|
|
|
||
|
|
# -- Project information -----------------------------------------------------
|
||
|
|
|
||
|
|
project = 'btcd'
|
||
|
|
copyright = '2020, btcd'
|
||
|
|
author = 'btcsuite developers'
|
||
|
|
|
||
|
|
# The full version, including alpha/beta/rc tags
|
||
|
|
release = 'beta'
|
||
|
|
|
||
|
|
source_suffix = ['.md']
|
||
|
|
|
||
|
|
# The master toctree document.
|
||
|
|
master_doc = 'index'
|
||
|
|
|
||
|
|
# -- 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.
|
||
|
|
extensions = [
|
||
|
|
'sphinx.ext.autodoc',
|
||
|
|
'sphinx.ext.napoleon',
|
||
|
|
'sphinx.ext.mathjax',
|
||
|
|
'sphinx_markdown_tables',
|
||
|
|
'recommonmark',
|
||
|
|
]
|
||
|
|
|
||
|
|
# 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']
|
||
|
|
|
||
|
|
# app setup hook
|
||
|
|
def setup(app):
|
||
|
|
app.add_config_value('recommonmark_config', {
|
||
|
|
#'url_resolver': lambda url: github_doc_root + url,
|
||
|
|
'auto_toc_tree_section': 'Contents',
|
||
|
|
'enable_math': False,
|
||
|
|
'enable_inline_math': False,
|
||
|
|
'enable_eval_rst': True,
|
||
|
|
'enable_auto_doc_ref': True,
|
||
|
|
}, True)
|
||
|
|
app.add_transform(AutoStructify)
|