iframe-proxy | Sunbelt Computer Software

History

222 lines (166 loc) · 6.69 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

# PyMongo documentation build configuration file

# This file is execfile()d with the current directory set to its containing dir.

from __future__ import annotations

import os

import sys

from pathlib import Path

sys.path[0:0] = [Path("..").resolve()]

import pymongo # noqa: E402

# -- 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.doctest",

"sphinx.ext.coverage",

"sphinx.ext.todo",

"sphinx.ext.intersphinx",

]

# Add optional extensions

try:

import sphinxcontrib.shellcheck # noqa: F401

extensions += ["sphinxcontrib.shellcheck"]

except ImportError:

pass

# Add any paths that contain templates here, relative to this directory.

templates_path = ["_templates"]

# The suffix of source filenames.

source_suffix = ".rst"

# The master toctree document.

master_doc = "index"

# General information about the project.

project = "PyMongo"

html_show_sphinx = False

# The version info for the project you're documenting, acts as replacement for

# |version| and |release|, also used in various other places throughout the

# built documents.

# The short X.Y version.

version = pymongo.version

# The full version, including alpha/beta/rc tags.

release = pymongo.version

# List of documents that shouldn't be included in the build.

unused_docs = []

# List of directories, relative to source directory, that shouldn't be searched

# for source files.

exclude_trees = ["_build"]

# The reST default role (used for this markup: `text`) to use for all documents.

# default_role = None

# If true, sectionauthor and moduleauthor directives will be shown in the

# output. They are ignored by default.

# show_authors = False

# If true, the current module name will be prepended to all description

# unit titles (such as .. function::).

add_module_names = True

# The name of the Pygments (syntax highlighting) style to use.

pygments_style = "sphinx"

# A list of ignored prefixes for module index sorting.

# modindex_common_prefix = []

# Options for link checking

# The anchors on the rendered markdown page are created after the fact,

# so those link results in a 404.

# wiki.centos.org has been flaky.

# sourceforge.net is giving a 403 error, but is still accessible from the browser.

# Links to release notes in jira give 401 error: unauthorized. PYTHON-5585

linkcheck_ignore = [

r"https://wiki.centos.org/[\w/]*",

r"https://sourceforge.net/",

r"https://jira\.mongodb\.org/secure/ReleaseNote\.jspa.*",

]

# Allow for flaky links.

linkcheck_retries = 3

# Serialize requests to dochub.mongodb.org to avoid rate-limiting (PYTHON-5847).

linkcheck_workers = 1

# Give slow redirects more time before retrying.

linkcheck_timeout = 60

# Ignore anchors in links

linkcheck_anchors = False

# Pass GitHub token to avoid rate-limiting on GitHub links.

if github_token := os.environ.get("GITHUB_TOKEN"):

linkcheck_request_headers = {

"https://github.com/": {"Authorization": f"token {github_token}"},

"https://api.github.com/": {"Authorization": f"token {github_token}"},

}

# -- Options for extensions ----------------------------------------------------

autoclass_content = "init"

autodoc_typehints = "description"

doctest_path = [Path("..").resolve()]

doctest_test_doctest_blocks = ""

doctest_global_setup = """

from pymongo.mongo_client import MongoClient

client = MongoClient()

client.drop_database("doctest_test")

db = client.doctest_test

server_major_version = int(client.server_info()['version'].split()[-1][0])

"""

# -- Options for HTML output ---------------------------------------------------

try:

import furo # noqa: F401

html_theme = "furo"

except ImportError:

# Theme gratefully vendored from CPython source.

html_theme = "pydoctheme"

html_theme_path = ["."]

html_theme_options = {"collapsiblesidebar": True, "googletag": False}

# Additional static files.

html_static_path = ["static"]

# The name for this set of Sphinx documents. If None, it defaults to

# "<project> v<release> documentation".

# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.

# html_short_title = None

# The name of an image file (relative to this directory) to place at the top

# of the sidebar.

# html_logo = None

# The name of an image file (within the static path) to use as favicon of the

# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32

# pixels large.

# html_favicon = None

# 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']

# Custom sidebar templates, maps document names to template names.

# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to

# template names.

# html_additional_pages = {}

# If true, links to the reST sources are added to the pages.

# html_show_sourcelink = True

# If true, an OpenSearch description file will be output, and all pages will

# contain a <link> tag referring to it. The value of this option must be the

# base URL from which the finished HTML is served.

# html_use_opensearch = ''

# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").

# html_file_suffix = ''

# Output file base name for HTML help builder.

htmlhelp_basename = "PyMongo" + release.replace(".", "_")

# -- Options for LaTeX output --------------------------------------------------

# The paper size ('letter' or 'a4').

# latex_paper_size = 'letter'

# The font size ('10pt', '11pt' or '12pt').

# latex_font_size = '10pt'

# Grouping the document tree into LaTeX files. List of tuples

# (source start file, target name, title, author, documentclass [howto/manual]).

latex_documents = [

("index", "PyMongo.tex", "PyMongo Documentation", "Michael Dirolf", "manual"),

]

# The name of an image file (relative to this directory) to place at the top

# of the title page.

# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,

# not chapters.

# latex_use_parts = False

# Additional stuff for the LaTeX preamble.

# latex_preamble = ''

# Documents to append as an appendix to all manuals.

# latex_appendices = []

# If false, no module index is generated.

# latex_use_modindex = True

intersphinx_mapping = {

"gevent": ("https://www.gevent.org/", None),

"py": ("https://docs.python.org/3/", None),

}

Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

conf.py

Latest commit

History

conf.py

File metadata and controls