1# Configuration file for the Sphinx documentation builder. 2# 3# This file does only contain a selection of the most common options. For a 4# full list see the documentation: 5# http://www.sphinx-doc.org/en/master/config 6 7# -- Path setup -------------------------------------------------------------- 8 9# If extensions (or modules to document with autodoc) are in another directory, 10# add these directories to sys.path here. If the directory is relative to the 11# documentation root, use os.path.abspath to make it absolute, like shown here. 12# 13# import os 14# import sys 15# sys.path.insert(0, os.path.abspath('.')) 16 17 18# -- Project information ----------------------------------------------------- 19 20from collections import OrderedDict 21 22import flask_smorest 23 24project = 'flask-smorest' 25copyright = '2021, Nobatek/INEF4 and contributors' 26 27version = release = flask_smorest.__version__ 28 29 30# -- General configuration --------------------------------------------------- 31 32# If your documentation needs a minimal Sphinx version, state it here. 33# 34# needs_sphinx = '1.0' 35 36# Add any Sphinx extension module names here, as strings. They can be 37# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 38# ones. 39extensions = [ 40 'sphinx.ext.autodoc', 41 'sphinx.ext.intersphinx', 42 'sphinx.ext.viewcode', 43 'sphinx_issues', 44] 45 46intersphinx_mapping = { 47 'marshmallow': ('http://marshmallow.readthedocs.io/en/latest/', None), 48 'apispec': ('http://apispec.readthedocs.io/en/latest/', None), 49 'webargs': ('http://webargs.readthedocs.io/en/latest/', None), 50 'werkzeug': ('http://werkzeug.palletsprojects.com/', None), 51 'flask': ('http://flask.palletsprojects.com/', None), 52 'sqlalchemy': ('http://docs.sqlalchemy.org/en/latest/', None), 53 'mongoengine': ('http://docs.mongoengine.org/', None), 54} 55 56issues_github_path = 'marshmallow-code/flask-smorest' 57 58# Add any paths that contain templates here, relative to this directory. 59templates_path = ['_templates'] 60 61# The suffix(es) of source filenames. 62# You can specify multiple suffix as a list of string: 63# 64# source_suffix = ['.rst', '.md'] 65source_suffix = '.rst' 66 67# The master toctree document. 68master_doc = 'index' 69 70# The language for content autogenerated by Sphinx. Refer to documentation 71# for a list of supported languages. 72# 73# This is also used if you do content translation via gettext catalogs. 74# Usually you set "language" from the command line for these cases. 75language = None 76 77# List of patterns, relative to source directory, that match files and 78# directories to ignore when looking for source files. 79# This pattern also affects html_static_path and html_extra_path . 80exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] 81 82# The name of the Pygments (syntax highlighting) style to use. 83pygments_style = 'sphinx' 84 85 86# -- Options for HTML output ------------------------------------------------- 87 88html_theme = 'alabaster' 89 90html_theme_options = { 91 'description': 'Build a REST API on Flask using Marshmallow', 92 'description_font_style': 'italic', 93 'github_user': 'marshmallow-code', 94 'github_repo': 'flask-smorest', 95 'github_button': False, 96 'github_banner': True, 97 'travis_button': True, 98 'code_font_size': '0.8em', 99 'extra_nav_links': OrderedDict([ 100 ( 101 'flask-smorest@PyPI', 102 'http://pypi.python.org/pypi/flask-smorest' 103 ), 104 ( 105 'flask-smorest@GitHub', 106 'http://github.com/marshmallow-code/flask-smorest' 107 ), 108 ]), 109} 110