python-firestore/docs/conf.py at main · QPC-github/python-firestore · GitHub

History

384 lines (304 loc) · 12.1 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

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

# -*- coding: utf-8 -*-

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

# google-cloud-firestore documentation build configuration file

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

# containing dir.

# Note that not all possible configuration values are present in this

# autogenerated file.

# All configuration values have a default; values that are commented out

# serve to show the default.

import sys

import os

import shlex

# If extensions (or modules to document with autodoc) are in another directory,

# add these directories to sys.path 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(".."))

# For plugins that can not read conf.py.

# See also: https://github.com/docascode/sphinx-docfx-yaml/issues/85

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

__version__ = ""

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.

needs_sphinx = "1.5.5"

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

"sphinx.ext.intersphinx",

"sphinx.ext.coverage",

"sphinx.ext.doctest",

"sphinx.ext.napoleon",

"sphinx.ext.todo",

"sphinx.ext.viewcode",

"recommonmark",

]

# autodoc/autosummary flags

autoclass_content = "both"

autodoc_default_options = {"members": True}

autosummary_generate = True

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

templates_path = ["_templates"]

# The suffix(es) of source filenames.

# You can specify multiple suffix as a list of string:

# source_suffix = ['.rst', '.md']

source_suffix = [".rst", ".md"]

# The encoding of source files.

# source_encoding = 'utf-8-sig'

# The root toctree document.

root_doc = "index"

# General information about the project.

project = "google-cloud-firestore"

author = "Google APIs"

# 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 full version, including alpha/beta/rc tags.

release = __version__

# The short X.Y version.

version = ".".join(release.split(".")[0:2])

# 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 = None

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

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

# directories to ignore when looking for source files.

exclude_patterns = [

"_build",

"**/.nox/**/*",

"samples/AUTHORING_GUIDE.md",

"samples/CONTRIBUTING.md",

"samples/snippets/README.rst",

]

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

# documents.

# default_role = None

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

# add_function_parentheses = True

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

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

# add_module_names = True

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

# output. They are ignored by default.

# show_authors = False

# 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 = []

# If true, keep warnings as "system message" paragraphs in the built documents.

# keep_warnings = False

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

todo_include_todos = True

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

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

# a list of builtin themes.

html_theme = "alabaster"

# Theme options are theme-specific and customize the look and feel of a theme

# further. For a list of options available for each theme, see the

# documentation.

html_theme_options = {

"description": "Google Cloud Client Libraries for google-cloud-firestore",

"github_user": "googleapis",

"github_repo": "python-firestore",

"github_banner": True,

"font_family": "'Roboto', Georgia, sans",

"head_font_family": "'Roboto', Georgia, serif",

"code_font_family": "'Roboto Mono', 'Consolas', monospace",

}

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

# html_theme_path = []

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

# Add any extra paths that contain custom files (such as robots.txt or

# .htaccess) here, relative to this directory. These files are copied

# directly to the root of the documentation.

# html_extra_path = []

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

# using the given strftime format.

# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to

# typographically correct entities.

# html_use_smartypants = True

# 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 false, no module index is generated.

# html_domain_indices = True

# If false, no index is generated.

# html_use_index = True

# If true, the index is split into individual pages for each letter.

# html_split_index = False

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

# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.

# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.

# html_show_copyright = 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 = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").

# html_file_suffix = None

# Language to be used for generating the HTML full-text search index.

# Sphinx supports the following languages:

# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'

# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'

# html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.

# Now only 'ja' uses this config value

# html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that

# implements a search results scorer. If empty, the default will be used.

# html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.

htmlhelp_basename = "google-cloud-firestore-doc"

# -- Options for warnings ------------------------------------------------------

suppress_warnings = [

# Temporarily suppress this to avoid "more than one target found for

# cross-reference" warning, which are intractable for us to avoid while in

# a mono-repo.

# See https://github.com/sphinx-doc/sphinx/blob

# /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843

"ref.python"

]

# -- 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 = [

(

root_doc,

"google-cloud-firestore.tex",

"google-cloud-firestore Documentation",

author,

"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

# If true, show page references after internal links.

# latex_show_pagerefs = False

# If true, show URL addresses after external links.

# latex_show_urls = False

# Documents to append as an appendix to all manuals.

# latex_appendices = []

# If false, no module index is generated.

# latex_domain_indices = True

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

# One entry per manual page. List of tuples

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

man_pages = [

(

root_doc,

"google-cloud-firestore",

"google-cloud-firestore Documentation",

[author],

)

]

# If true, show URL addresses after external links.

# man_show_urls = False

# -- 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 = [

(

root_doc,

"google-cloud-firestore",

"google-cloud-firestore Documentation",

author,

"google-cloud-firestore",

"google-cloud-firestore Library",

"APIs",

)

]

# Documents to append as an appendix to all manuals.

# texinfo_appendices = []

# If false, no module index is generated.

# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.

# texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.

# texinfo_no_detailmenu = False

# Example configuration for intersphinx: refer to the Python standard library.

intersphinx_mapping = {

"python": ("https://python.readthedocs.org/en/latest/", None),

"google-auth": ("https://googleapis.dev/python/google-auth/latest/", None),

"google.api_core": (

"https://googleapis.dev/python/google-api-core/latest/",

None,

"grpc": ("https://grpc.github.io/grpc/python/", None),

"proto-plus": ("https://proto-plus-python.readthedocs.io/en/latest/", None),

"protobuf": ("https://googleapis.dev/python/protobuf/latest/", None),

}

# Napoleon settings

napoleon_google_docstring = True

napoleon_numpy_docstring = True

napoleon_include_private_with_doc = False

napoleon_include_special_with_doc = True

napoleon_use_admonition_for_examples = False

napoleon_use_admonition_for_notes = False

napoleon_use_admonition_for_references = False

napoleon_use_ivar = False

napoleon_use_param = True

napoleon_use_rtype = True

python-firestore/docs/conf.py at main · QPC-github/python-firestore · GitHub

Expand file tree

Breadcrumbs

conf.py

Latest commit

History

Breadcrumbs

conf.py

File metadata and controls