diffpy.srreal/docs/source/conf.py at main · diffpy/diffpy.srreal · GitHub

Repository navigation

History

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

#!/usr/bin/env python

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

# diffpy.srreal documentation build configuration file, created by # noqa: E501

# sphinx-quickstart on Thu Jan 30 15:49:41 2014.

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

from importlib.metadata import version

from pathlib import Path

# Attempt to import the version dynamically from GitHub tag.

try:

fullversion = version("diffpy.srreal")

except Exception:

fullversion = "No version found. The correct version will appear in the released version." # noqa: E501

# 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 Path().resolve() to make it absolute, like shown here. # noqa: E501

# sys.path.insert(0, str(Path(".").resolve()))

sys.path.insert(0, str(Path("../..").resolve()))

sys.path.insert(0, str(Path("../../src").resolve()))

# abbreviations

ab_authors = "Pavol Juhás, Christopher L. Farrow, Simon J.L. Billinge group"

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

"sphinx.ext.todo",

"sphinx.ext.viewcode",

"sphinx.ext.intersphinx",

"sphinx_rtd_theme",

"sphinx_copybutton",

"m2r2",

]

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

# The encoding of source files.

# source_encoding = 'utf-8-sig'

# The master toctree document.

master_doc = "index"

# General information about the project.

project = "diffpy.srreal"

# 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 = "".join(fullversion.split(".post")[:1])

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

release = fullversion

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

# for a list of supported languages.

# language = None

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

# non-false value, then it is used:

# today = ''

today = time.strftime("%B %d, %Y", time.localtime())

year = today.split()[-1]

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

# today_fmt = '%B %d, %Y'

# substitute YEAR in the copyright string

# For sphinx_copybutton extension.

# Do not copy "$" for shell commands in code-blocks.

copybutton_prompt_text = r"^\$ "

copybutton_prompt_is_regexp = True

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

# directories to ignore when looking for source files.

exclude_patterns = ["build"]

# 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 = ["diffpy.srreal"]

# Display all warnings for missing links.

nitpicky = 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 = "sphinx_rtd_theme"

html_context = {

"display_github": True,

"github_user": "diffpy",

"github_repo": "diffpy.srreal",

"github_version": "main",

"conf_py_path": "/docs/source/",

}

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

"navigation_with_keys": "true",

}

# 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

# Output file base name for HTML help builder.

basename = "diffpy.srreal".replace(" ", "").replace(".", "")

htmlhelp_basename = basename + "doc"

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

}

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

(

"index",

"diffpy.srreal.tex",

"diffpy.srreal Documentation",

ab_authors,

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

(

"index",

"diffpy.srreal",

"diffpy.srreal Documentation",

ab_authors,

)

]

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

(

"index",

"diffpy.srreal",

"diffpy.srreal Documentation",

ab_authors,

"diffpy.srreal",

"One line description of project.",

"Miscellaneous",

]

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

"numpy": ("https://numpy.org/doc/stable/", None),

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

}

diffpy.srreal/docs/source/conf.py at main · diffpy/diffpy.srreal · GitHub

Repository navigation

Expand file tree

Breadcrumbs

conf.py

Latest commit

History

Breadcrumbs

conf.py

File metadata and controls