Differential D1942 Diff 6556 swh/docs/sphinx/conf.py

Changeset View

Standalone View

swh/docs/sphinx/conf.py

	Show All 17 Lines
	extensions = ['sphinx.ext.autodoc',			extensions = ['sphinx.ext.autodoc',
	'sphinx.ext.napoleon',			'sphinx.ext.napoleon',
	'sphinxcontrib.httpdomain',			'sphinxcontrib.httpdomain',
	'sphinx.ext.extlinks',			'sphinx.ext.extlinks',
	'sphinxcontrib.images',			'sphinxcontrib.images',
	'sphinxcontrib.programoutput',			'sphinxcontrib.programoutput',
	'sphinx.ext.viewcode',			'sphinx.ext.viewcode',
	'sphinx_tabs.tabs',			'sphinx_tabs.tabs',
				'sphinx_rtd_theme',
	]			]

	# Add any paths that contain templates here, relative to this directory.			# Add any paths that contain templates here, relative to this directory.
	templates_path = ['_templates']			templates_path = ['_templates']

	# The suffix(es) of source filenames.			# The suffix(es) of source filenames.
	# You can specify multiple suffix as a list of string:			# You can specify multiple suffix as a list of string:
	#			#
	▲ Show 20 Lines • Show All 42 Lines • ▼ Show 20 Lines
	todo_include_todos = True			todo_include_todos = True


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

	# The theme to use for HTML and HTML Help pages. See the documentation for			# The theme to use for HTML and HTML Help pages. See the documentation for
	# a list of builtin themes.			# a list of builtin themes.
	#			#
	html_theme = 'alabaster'			html_theme = 'sphinx_rtd_theme'

	html_favicon = '_static/favicon.ico'			html_favicon = '_static/favicon.ico'

	# Theme options are theme-specific and customize the look and feel of a theme			# 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			# further. For a list of options available for each theme, see the
	# documentation.			# documentation.
	#			#
	html_theme_options = {			html_theme_options = {
	'logo': 'software-heritage-logo-title-motto-vertical.svg',			'collapse_navigation': True,
	'font_family': "'Alegreya Sans', sans-serif",			'sticky_navigation': True,
	'head_font_family': "'Alegreya', serif",
	# equivalent of alabaster's:
	'gray_1': '#5b5e6f', # dark gray
	'gray_2': '#efeff2', # light gray
	'gray_3': '#b1b5ae', # medium gray
	'pink_1': '#e5d4cf', # light pink
	'pink_2': '#bd9f97', # medium pink
	'fixed_sidebar': 'true',
	}			}

				html_logo = 'software-heritage-logo-title-motto-vertical-white.png'

	# Add any paths that contain custom static files (such as style sheets) here,			# 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,			# relative to this directory. They are copied after the builtin static files,
	# so a file named "default.css" will overwrite the builtin "default.css".			# so a file named "default.css" will overwrite the builtin "default.css".
	html_static_path = ['_static']			html_static_path = ['_static']

	# make logo actually appear, avoiding gotcha due to alabaster default conf.			# make logo actually appear, avoiding gotcha due to alabaster default conf.
	# https://github.com/bitprophet/alabaster/issues/97#issuecomment-303722935			# https://github.com/bitprophet/alabaster/issues/97#issuecomment-303722935
	html_sidebars = {			html_sidebars = {
	'**': [			'**': [
	'about.html',			'about.html',
	'localtoc.html',			'globaltoc.html',
	'relations.html',			'relations.html',
	'sourcelink.html',			'sourcelink.html',
	'searchbox.html',			'searchbox.html',
	]			]
	}			}


	# refer to the Python standard library.			# refer to the Python standard library.
	Show All 37 Lines