papermill

1
#!/usr/bin/env python3
2
#
3
# papermill documentation build configuration file, created by
4
# sphinx-quickstart on Mon Jan 15 09:50:01 2018.
5
#
6
# This file is execfile()d with the current directory set to its
7
# containing dir.
8
#
9
# Note that not all possible configuration values are present in this
10
# autogenerated file.
11
#
12
# All configuration values have a default; values that are commented out
13
# serve to show the default.
14

15
# If extensions (or modules to document with autodoc) are in another directory,
16
# add these directories to sys.path here. If the directory is relative to the
17
# documentation root, use os.path.abspath to make it absolute, like shown here.
18
#
19
import os
20
import sys
21

22
sys.path.insert(0, os.path.abspath('..'))
23

24
# -- General configuration ------------------------------------------------
25

26
# If your documentation needs a minimal Sphinx version, state it here.
27
#
28
needs_sphinx = '3.0'
29

30
# Add any Sphinx extension module names here, as strings. They can be
31
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32
# ones.
33
extensions = [
34
    'sphinx.ext.autodoc',
35
    'sphinx.ext.intersphinx',
36
    'sphinx.ext.mathjax',
37
    'sphinx.ext.napoleon',
38
    'myst_parser',
39
    'sphinx_copybutton',
40
]
41

42
# Add any paths that contain templates here, relative to this directory.
43
templates_path = ['_templates']
44

45
# The suffix(es) of source filenames.
46
# You can specify multiple suffix as a list of string:
47
#
48
source_suffix = ['.rst', '.md', '.ipynb']
49

50
# The master toctree document.
51
master_doc = 'index'
52

53
# General information about the project.
54
project = 'papermill'
55
copyright = '2018, nteract team'
56
author = 'nteract team'
57

58
# The version info for the project you're documenting, acts as replacement for
59
# |version| and |release|, also used in various other places throughout the
60
# built documents.
61
#
62
import papermill
63

64
# The short X.Y version.
65
version = '.'.join(papermill.__version__.split('.')[0:2])
66

67
# The full version, including alpha/beta/rc tags.
68
release = papermill.__version__
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 foexitr these cases.
75
language = 'python'
76

77
# List of patterns, relative to source directory, that match files and
78
# directories to ignore when looking for source files.
79
# This patterns also effect to html_static_path and html_extra_path
80
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'UPDATE.md']
81

82
# The name of the Pygments (syntax highlighting) style to use.
83
pygments_style = "sphinx"
84

85
# If true, `todo` and `todoList` produce output, else they produce nothing.
86
todo_include_todos = False
87

88

89
# -- Options for HTML output ----------------------------------------------
90

91
# The theme to use for HTML and HTML Help pages.  See the documentation for
92
# a list of builtin themes.
93
html_theme = "furo"
94

95
# Theme options are theme-specific and customize the look and feel of a theme
96
# further.  For a list of options available for each theme, see the
97
# documentation.
98
#
99
html_theme_options = {
100
    "sidebar_hide_name": True,
101
}
102

103
# Add any paths that contain custom static files (such as style sheets) here,
104
# relative to this directory. They are copied after the builtin static files,
105
# so a file named "default.css" will overwrite the builtin "default.css".
106
html_static_path = ['_static']
107

108
html_logo = "_static/images/papermill.png"
109

110
# -- Options for HTMLHelp output ------------------------------------------
111

112
# Output file base name for HTML help builder.
113
htmlhelp_basename = 'papermilldoc'
114

115
# -- Options for LaTeX output ---------------------------------------------
116

117
latex_elements = {
118
    # The paper size ('letterpaper' or 'a4paper').
119
    #
120
    # 'papersize': 'letterpaper',
121
    # The font size ('10pt', '11pt' or '12pt').
122
    #
123
    # 'pointsize': '10pt',
124
    # Additional stuff for the LaTeX preamble.
125
    #
126
    # 'preamble': '',
127
    # Latex figure (float) alignment
128
    #
129
    # 'figure_align': 'htbp',
130
}
131

132
# Grouping the document tree into LaTeX files. List of tuples
133
# (source start file, target name, title,
134
#  author, documentclass [howto, manual, or own class]).
135
latex_documents = [(master_doc, 'papermill.tex', 'papermill Documentation', 'nteract team', 'manual')]
136

137

138
# -- Options for manual page output ---------------------------------------
139

140
# One entry per manual page. List of tuples
141
# (source start file, name, description, authors, manual section).
142
man_pages = [(master_doc, 'papermill', 'papermill Documentation', [author], 1)]
143

144

145
# -- Options for Texinfo output -------------------------------------------
146

147
# Grouping the document tree into Texinfo files. List of tuples
148
# (source start file, target name, title, author,
149
#  dir menu entry, description, category)
150
texinfo_documents = [
151
    (
152
        master_doc,
153
        'papermill',
154
        'papermill Documentation',
155
        author,
156
        'papermill',
157
        'One line description of project.',
158
        'Miscellaneous',
159
    )
160
]
161

162
# Example configuration for intersphinx: refer to the Python standard library.
163
intersphinx_mapping = {'python': ('https://docs.python.org/', None)}
164