doc_config.py
No OneTemporary
Actions

Size

1 KB

Subscribers

None

doc_config.py
View Options

	# Copyright (C) 2017-2018 The Software Heritage developers
	# See the AUTHORS file at the top-level directory of this distribution
	# License: GNU General Public License version 3, or any later version
	# See top-level LICENSE file for more information

	from sphinxcontrib import httpdomain

	_swh_web_base_url = 'https://archive.softwareheritage.org'
	_swh_web_api_endpoint = 'api'
	_swh_web_api_version = 1
	_swh_web_api_url = '%s/%s/%s/' % (_swh_web_base_url,
	_swh_web_api_endpoint,
	_swh_web_api_version)

	_swh_web_browse_endpoint = 'browse'
	_swh_web_browse_url = '%s/%s/' % (_swh_web_base_url,
	_swh_web_browse_endpoint)


	def customize_sphinx_conf(sphinx_conf):
	"""
	Utility function used to customize the sphinx doc build for swh-web
	globally (when building doc from swh-docs) or locally (when building doc
	from swh-web).

	Args:
	sphinx_conf (module): a reference to the sphinx conf.py module
	used to build the doc.
	"""
	# fix for sphinxcontrib.httpdomain 1.3
	if 'Link' not in httpdomain.HEADER_REFS:
	httpdomain.HEADER_REFS['Link'] = httpdomain.IETFRef(5988, '5')
	sphinx_conf.extlinks['swh_web_api'] = (_swh_web_api_url + '%s', None)
	sphinx_conf.extlinks['swh_web_browse'] = (_swh_web_browse_url + '%s', None)