iframe-proxy | Sunbelt Computer Software

History

182 lines (148 loc) · 5.47 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

# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries

# SPDX-License-Identifier: MIT

import datetime

import os

import sys

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

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

"sphinxcontrib.jquery",

"sphinx.ext.intersphinx",

"sphinx.ext.napoleon",

"sphinx.ext.todo",

]

# Uncomment the below if you use native CircuitPython modules such as

# digitalio, micropython and busio. List the modules you use. Without it, the

# autodoc module docs will fail to generate with a warning.

autodoc_mock_imports = ["vectorio", "bitmaptools"]

autodoc_preserve_defaults = True

intersphinx_mapping = {

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

"CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),

}

# Show the docstring from both the class and its __init__() method.

autoclass_content = "both"

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

templates_path = ["_templates"]

source_suffix = ".rst"

# The master toctree document.

master_doc = "index"

# General information about the project.

project = "CircuitPython DisplayIO_Cartesian Library"

creation_year = "2025"

current_year = str(datetime.datetime.now().year)

year_duration = (

current_year if current_year == creation_year else creation_year + " - " + current_year

)

author = "Jose David M."

# 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 = "1.0"

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

release = "1.0"

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

# This is also used if you do content translation via gettext catalogs.

# Usually you set "language" from the command line for these cases.

language = "en"

# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

# This patterns also effect to html_static_path and html_extra_path

exclude_patterns = [

"_build",

"Thumbs.db",

".DS_Store",

".env",

"CODE_OF_CONDUCT.md",

]

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

# documents.

default_role = "any"

# If true, '()' will be appended to :func: etc. cross-reference text.

add_function_parentheses = True

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

pygments_style = "sphinx"

# If true, `todo` and `todoList` produce output, else they produce nothing.

todo_include_todos = False

# If this is True, todo emits a warning for each TODO entries. The default is False.

todo_emit_warnings = True

napoleon_numpy_docstring = False

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

# The theme to use for HTML and HTML Help pages. See the documentation for

# a list of builtin themes.

import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"

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

# The name of an image file (relative to this directory) to use as a favicon of

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

# pixels large.

html_favicon = "_static/favicon.ico"

# Output file base name for HTML help builder.

htmlhelp_basename = "CircuitPython_Displayio_cartesian_Librarydoc"

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

latex_elements = {

# The paper size ('letterpaper' or 'a4paper').

# 'papersize': 'letterpaper',

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

# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.

# 'preamble': '',

# Latex figure (float) alignment

# 'figure_align': 'htbp',

}

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

# (source start file, target name, title,

# author, documentclass [howto, manual, or own class]).

latex_documents = [

(

master_doc,

"CircuitPython_DisplayIO_Cartesian_Library.tex",

"CircuitPython DisplayIO_Cartesian Library Documentation",

author,

"manual",

]

# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples

# (source start file, name, description, authors, manual section).

man_pages = [

(

master_doc,

"CircuitPython_DisplayIO_Cartesian_Library",

"CircuitPython DisplayIO_Cartesian Library Documentation",

[author],

]

# -- Options for Texinfo output -------------------------------------------

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

# (source start file, target name, title, author,

# dir menu entry, description, category)

texinfo_documents = [

(

master_doc,

"CircuitPython_DisplayIO_Cartesian_Library",

"CircuitPython DisplayIO_Cartesian Library Documentation",

author,

"CircuitPython_DisplayIO_Cartesian_Library",

"One line description of project.",

"Miscellaneous",

]

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