|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +# |
| 3 | +# Configuration file for the Sphinx documentation builder. |
| 4 | +# |
| 5 | +# This file does only contain a selection of the most common options. For a |
| 6 | +# full list see the documentation: |
| 7 | +# http://www.sphinx-doc.org/en/stable/config |
| 8 | + |
| 9 | +# -- Path setup -------------------------------------------------------------- |
| 10 | + |
| 11 | +# If extensions (or modules to document with autodoc) are in another directory, |
| 12 | +# add these directories to sys.path here. If the directory is relative to the |
| 13 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
| 14 | +# |
| 15 | +# import os |
| 16 | +# import sys |
| 17 | +# sys.path.insert(0, os.path.abspath('.')) |
| 18 | + |
| 19 | + |
| 20 | +# -- Project information ----------------------------------------------------- |
| 21 | + |
| 22 | +project = 'References' |
| 23 | +copyright = '1982, Author' |
| 24 | +author = 'Author' |
| 25 | + |
| 26 | +# The short X.Y version |
| 27 | +version = '' |
| 28 | +# The full version, including alpha/beta/rc tags |
| 29 | +release = '' |
| 30 | + |
| 31 | + |
| 32 | +# -- General configuration --------------------------------------------------- |
| 33 | + |
| 34 | +# If your documentation needs a minimal Sphinx version, state it here. |
| 35 | +# |
| 36 | +# needs_sphinx = '1.0' |
| 37 | + |
| 38 | +# Add any Sphinx extension module names here, as strings. They can be |
| 39 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 40 | +# ones. |
| 41 | +extensions = [ |
| 42 | + 'sphinx.ext.autodoc', |
| 43 | + 'sphinx.ext.napoleon', |
| 44 | +] |
| 45 | + |
| 46 | +# Add any paths that contain templates here, relative to this directory. |
| 47 | +templates_path = ['_templates'] |
| 48 | + |
| 49 | +# The suffix(es) of source filenames. |
| 50 | +# You can specify multiple suffix as a list of string: |
| 51 | +# |
| 52 | +# source_suffix = ['.rst', '.md'] |
| 53 | +source_suffix = '.rst' |
| 54 | + |
| 55 | +# The master toctree document. |
| 56 | +master_doc = 'index' |
| 57 | + |
| 58 | +# The language for content autogenerated by Sphinx. Refer to documentation |
| 59 | +# for a list of supported languages. |
| 60 | +# |
| 61 | +# This is also used if you do content translation via gettext catalogs. |
| 62 | +# Usually you set "language" from the command line for these cases. |
| 63 | +#language = None |
| 64 | + |
| 65 | +# List of patterns, relative to source directory, that match files and |
| 66 | +# directories to ignore when looking for source files. |
| 67 | +# This pattern also affects html_static_path and html_extra_path . |
| 68 | +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 69 | + |
| 70 | +# The name of the Pygments (syntax highlighting) style to use. |
| 71 | +pygments_style = 'sphinx' |
| 72 | + |
| 73 | +numfig = True |
| 74 | + |
| 75 | +# -- Options for rinohtype PDF output ---------------------------------------- |
| 76 | + |
| 77 | +rinoh_documents = [{ |
| 78 | + 'doc': master_doc, # top-level file (index.rst) |
| 79 | + 'target': 'pyref', # output (target.pdf) |
| 80 | + 'title': project, # document title |
| 81 | + 'author': author, # document author |
| 82 | + 'template': 'template.rtt' # document template |
| 83 | +}] |
0 commit comments