python-semver/docs/conf.py at master · python-semver/python-semver · GitHub

History

292 lines (248 loc) · 8.65 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

#!/usr/bin/env python3

# python-semver 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.

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

import os

import re

from datetime import date

from pathlib import Path

SRC_DIR = Path(__file__).absolute().parent.parent / "src"

YEAR = date.today().year

def find_version(path: Path) -> str:

"""

Build a path from *file_paths* and search for a ``__version__``

string inside.

"""

content = Path(path).read_text(encoding="utf-8")

version_match = re.search(

r"^__version__ = ['\"]([^'\"]*)['\"]",

content,

re.MULTILINE

)

if version_match:

return version_match.group(1)

raise RuntimeError("Unable to find version string.")

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

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

# needs_sphinx = '1.0'

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

"sphinx.ext.intersphinx",

"sphinx.ext.extlinks",

]

# Autodoc configuration

autoclass_content = "class"

autodoc_typehints = "signature"

autodoc_member_order = "alphabetical"

add_function_parentheses = 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"

# The master toctree document.

master_doc = "index"

# General information about the project.

project = "python-semver"

author = "Kostiantyn Rybnikov, Tom Schraitle, Sebastien Celles, and others"

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

release = find_version(SRC_DIR / "semver/__about__.py")

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

version = release # .rsplit(u".", 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"]

# 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

# Markup to shorten external links

# See https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html

extlinks = {

"gh": ("https://github.com/python-semver/python-semver/issues/%s", "#%s"),

"pr": ("https://github.com/python-semver/python-semver/pull/%s", "PR #%s"),

}

# Link to other projects’ documentation

# See https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html

intersphinx_mapping = {

# Download it from the root with:

# wget -O docs/inventories/python-objects.inv https://docs.python.org/3/objects.inv

"python": ("https://docs.python.org/3", (None, "inventories/python-objects.inv")),

# wget -O docs/inventories/pydantic.inv https://docs.pydantic.dev/latest/objects.inv

"pydantic": (

"https://docs.pydantic.dev/latest/",

(None, "inventories/pydantic.inv"),

}

# Avoid side-effects (namely that documentations local references can

# suddenly resolve to an external location.)

intersphinx_disabled_reftypes = ["*"]

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

templates_path = ["_templates"]

GITHUB_URL = "https://github.com/python-semver/python-semver"

html_theme_options = {

# -- Basics

#: Text blurb about your project to appear under the logo:

# "description": "Semantic versioning",

#: Makes the sidebar "fixed" or pinned in place:

"fixed_sidebar": True,

#: Relative path to $PROJECT/_static to logo image:

"logo": "logo.svg",

#: Set to true to insert your site's project name under

#: the logo:

# "logo_name": True,

#: CSS width specifier controller default sidebar width:

"sidebar_width": "25%",

#: CSS width specifier controlling default content/page width:

"page_width": "auto",

#: CSS width specifier controlling default body text width:

"body_max_width": "auto",

# -- Service Links and Badges

#: Contains project name and user of GitHub:

"github_user": "python-semver",

"github_repo": "python-semver",

#: whether to link to your GitHub:

"github_button": True,

"github_type": "star",

#: whether to apply a "Fork me on Github" banner

#: in the top right corner of the page:

# "github_banner": True,

# -- Non-service sidebar control

#: Dictionary mapping link names to link targets:

"extra_nav_links": {

"PyPI": "https://pypi.org/project/semver/",

"Libraries.io": "https://libraries.io/pypi/semver",

#: Boolean determining whether all TOC entries that

#: are not ancestors of the current page are collapsed:

"sidebar_collapse": True,

# -- Header/footer options

#: used to display next and previous links above and

#: below the main page content

"show_relbars": True,

"show_relbar_top": True,

# -- Style colors

# "anchor": "",

# "anchor_hover_bg": "",

# "anchor_hover_fg": "",

"narrow_sidebar_fg": "lightgray",

# -- Fonts

# "code_font_size": "",

"font_family": "'Roboto',sans-serif",

"head_font_family": "'Roboto Slab',serif",

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

"font_size": "1.20rem",

}

html_static_path = ["_static"]

html_css_files = ["css/custom.css"]

html_sidebars = {

"**": [

"about.html", # theme_logo

# 'relations.html', # prev and next

"searchbox.html", # basic/searchbox.html

"navigation.html", # TOC

# 'donate.html',

]

}

# Canonical link relation

if os.environ.get("READTHEDOCS_CANONICAL_URL"):

html_baseurl = f"{os.environ['READTHEDOCS_CANONICAL_URL']}"

# html_logo = "logo.svg"

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.

htmlhelp_basename = "semverdoc"

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

"semver.tex",

"python-semver Documentation",

"Kostiantyn Rybnikov and all",

"manual",

)

]

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

# One entry per manual page. List of tuples

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

manpage_doc = "pysemver"

man_pages = [

(

manpage_doc,

"pysemver",

"Helper script for Semantic Versioning",

["Thomas Schraitle"],

)

]

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

"semver",

"python-semver Documentation",

author,

"semver",

"One line description of project.",

"Miscellaneous",

)

]

python-semver/docs/conf.py at master · python-semver/python-semver · GitHub

Uh oh!

Expand file tree

Breadcrumbs

conf.py

Latest commit

History

Breadcrumbs

conf.py

File metadata and controls