iframe-proxy | Sunbelt Computer Software

History

executable file

205 lines (164 loc) · 5.81 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

# IPython documentation build configuration file.

# NOTE: This file has been edited manually from the auto-generated one from

# sphinx. Do NOT delete and re-generate. If any changes from sphinx are

# needed, generate a scratch one and merge by hand any new fields needed.

import sys, os

from pathlib import Path

from sphinx_toml import load_into_locals

from intersphinx_registry import get_intersphinx_mapping

import sphinx_rtd_theme

import sphinx.util

import logging

load_into_locals(locals())

# https://read-the-docs.readthedocs.io/en/latest/faq.html

ON_RTD = os.environ.get("READTHEDOCS", None) == "True"

if ON_RTD:

tags.add("rtd")

# RTD doesn't use the Makefile, so re-run autogen_{things}.py here.

for name in ("config", "api", "magics", "shortcuts"):

fname = Path("autogen_{}.py".format(name))

fpath = (Path(__file__).parent).joinpath("..", fname)

with open(fpath, encoding="utf-8") as f:

exec(

compile(f.read(), fname, "exec"),

{

"__file__": fpath,

"__name__": "__main__",

)

# Allow Python scripts to change behaviour during sphinx run

os.environ["IN_SPHINX_RUN"] = "True"

autodoc_type_aliases = {

"Matcher": " IPython.core.completer.Matcher",

"MatcherAPIv1": " IPython.core.completer.MatcherAPIv1",

}

# If your extensions are in another directory, add it here. If the directory

# is relative to the documentation root, use os.path.abspath to make it

# absolute, like shown here.

sys.path.insert(0, os.path.abspath("../sphinxext"))

# We load the ipython release info into a dict by explicit execution

iprelease = {}

exec(

compile(

open("../../IPython/core/release.py", encoding="utf-8").read(),

"../../IPython/core/release.py",

"exec",

iprelease,

)

# General configuration

# ---------------------

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

# - master_doc: The master toctree document.

# - project

# - copyright

# - github_project_url

# - source_suffix = config["sphinx"]["source_suffix"]

# - exclude_patterns:

# Exclude these glob-style patterns when looking for source files.

# They are relative to the source/ directory.

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

# - default_role

# - modindex_common_prefix

intersphinx_mapping = get_intersphinx_mapping(

packages={

"python",

"rpy2",

"jupyterclient",

"jupyter",

"jedi",

"traitlets",

"ipykernel",

"prompt_toolkit",

"ipywidgets",

"ipyparallel",

"pip",

}

)

# External links configuration (replaces custom github extension)

extlinks = {

"ghissue": ("https://github.com/ipython/ipython/issues/%s/", "#%s"),

"ghpull": ("https://github.com/ipython/ipython/pull/%s/", "PR #%s"),

}

# Options for HTML output

# -----------------------

# - html_theme

# - html_static_path

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

# Favicon needs the directory name

# - html_favicon

# - html_last_updated_fmt = config["html"]["html_last_updated_fmt"]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

# using the given strftime format.

# Output file base name for HTML help builder.

# - htmlhelp_basename

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

# template names.

# Options for texinfo output

# --------------------------

texinfo_documents = [

(

master_doc,

"ipython",

"IPython Documentation",

"The IPython Development Team",

"IPython",

"IPython Documentation",

"Programming",

]

#########################################################################

# Custom configuration

# The default replacements for |version| and |release|, also used in various

# other places throughout the built documents.

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

release = "%s" % iprelease["version"]

# Just the X.Y.Z part, no '.dev'

version = ".".join(map(str, iprelease["version_info"][:3]))

# There are two options for replacing |today|: either, you set today to some

# non-false value, then it is used:

# today = ''

# Else, today_fmt is used as the format for a strftime call.

today_fmt = "%B %d, %Y"

rst_prolog = ""

def is_stable(extra):

return all(ext not in extra for ext in {"dev", "b", "rc"})

if is_stable(iprelease["_version_extra"]):

tags.add("ipystable")

print("Adding Tag: ipystable")

else:

tags.add("ipydev")

print("Adding Tag: ipydev")

rst_prolog += """

.. warning::

This documentation covers a development version of IPython. The development

version may differ significantly from the latest stable release.

"""

class ConfigtraitFilter(logging.Filter):

"""

This is a filter to remove in sphinx 3+ the error about config traits being duplicated.

As we autogenerate configuration traits from, subclasses have lots of

duplication and we want to silence them. Indeed we build on travis with

warnings-as-error set to True, so those duplicate items make the build fail.

"""

def filter(self, record):

if (

record.args

and record.args[0] == "configtrait"

and "duplicate" in record.msg

return False

return True

ct_filter = ConfigtraitFilter()

logger = sphinx.util.logging.getLogger("sphinx.domains.std").logger

logger.addFilter(ct_filter)

def setup(app):

app.add_css_file("theme_overrides.css")

# Cleanup

# -------

# delete release info to avoid pickling errors from sphinx

del iprelease

Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Uh oh!

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

Uh oh!

FilesExpand file tree

conf.py

Latest commit

History

conf.py

File metadata and controls