doc/conf.py - chromiumos/platform/factory - Git at Google

 # Copyright 2013 The ChromiumOS Authors
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.

 #
 # Note: This is based on a skeleton file generated by sphinx-quickstart.
 #

 import os
 import re
 import sys
 import time

 from recommonmark.parser import CommonMarkParser
 from sphinx.domains import Domain


 MD_DIR = 'md'
 SRC_URI_ROOT = (
     'https://chromium.googlesource.com/chromiumos/platform/factory/+/re'
     'fs/heads/main/')


 class MarkdownParser(CommonMarkParser):
   """
   Custom parser for Markdown documents.
   """

   supported = ['md', 'markdown']

   def parse(self, inputstring, document):
     path = document.current_source.split(MD_DIR, 1)[-1]
     path = path.lstrip('/')
     src_uri = os.path.join(SRC_URI_ROOT, path)

     # Add source code link in prolog
     prolog = f'**source code:** [{path}]({src_uri})\n\n'

     # The note syntax is not standard Markdown syntax, replace with bold font:
     # *** note
     # SOMTHING
     # ***
     # -> **SOMETHING**
     inputstring = re.sub(r'\*\*\* note *\n(?P<text>.*?)\n\*\*\*',
                          r'**\g<text>**', inputstring, flags=re.DOTALL)
     super(MarkdownParser, self).parse(prolog + inputstring, document)


 class ChromiumURLDomain(Domain):
   """
   Resolve certain links in markdown files to chromium source.
   """

   name = 'chromiumurl'

   def resolve_any_xref(self, env, fromdocname, builder, target, node, contnode):
     uri = os.path.join('/'.join(fromdocname.split('/')[1:-1]), target)

     # recommonmark will auto trim .md in the links, check if the link refer
     # to a .md link not in the document page.
     #
     # If uri is a .md file, ignore the link and it will automatic refer to
     # the document page.
     if os.path.exists(os.path.join(MD_DIR, uri + '.md')):
       return []

     contnode['refuri'] = os.path.join(SRC_URI_ROOT, uri)
     return [(f'{self.name}:any', contnode)]


 # 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.
 py_pkg = os.getenv('CROS_FACTORY_PY_ROOT')
 if py_pkg is None:
   py_pkg = os.path.dirname(os.path.abspath(__file__))
   while py_pkg != '/' and not os.path.exists(os.path.join(py_pkg, 'py_pkg')):
     py_pkg = os.path.dirname(py_pkg)
   py_pkg = os.path.join(py_pkg, 'py_pkg')

 # We want to treat py/shopfloor as a standalone 'reference' folder without
 # importing it as module so there's no __init__.py and need to be explicitly
 # inserted into path for shopfloor_api.rst.
 py_shopfloor = os.path.join(py_pkg, 'cros', 'factory', 'shopfloor')

 assert os.path.exists(py_pkg), 'Failed to find py_pkg.'
 if py_pkg not in sys.path:
   sys.path.insert(0, py_pkg)
 if py_shopfloor not in sys.path:
   sys.path.insert(0, py_shopfloor)

 # -- 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.doctest', 'recommonmark',
     'cros.factory.doc.factory_docs'
 ]

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

 # The suffix of source filenames.
 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 = 'CrOS Factory'

 # 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.  We just use the current date as the version for now.
 version = time.strftime('%Y%m%d')
 # The full version, including alpha/beta/rc tags.
 release = version

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

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


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

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

 # 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 = ('%s %s documentation %s' % (
     project, version, os.environ.get('DOC_TITLE_SUFFIX', ''))).strip()

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

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

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

 # 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

 html_style = 'factory.css'

 # Output file base name for HTML help builder.
 htmlhelp_basename = 'factorydoc'


 # -- 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]).
 latex_documents = [
     ('index', 'factory.tex', 'CrOS Factory Documentation', 'CrOS Factory',
      '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', 'factory', 'CrOS Factory Documentation', [
     'CrOS Factory'
 ], 1)]

 # 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', 'factory', 'CrOS Factory Documentation', 'CrOS Factory',
      'factory', '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'

 autodoc_member_order = 'bysource'


 # app setup hook
 def setup(app):
   app.add_domain(ChromiumURLDomain)
   app.add_source_parser(MarkdownParser, override=True)
	# Copyright 2013 The ChromiumOS Authors
	# Use of this source code is governed by a BSD-style license that can be
	# found in the LICENSE file.

	#
	# Note: This is based on a skeleton file generated by sphinx-quickstart.
	#

	import os
	import re
	import sys
	import time

	from recommonmark.parser import CommonMarkParser
	from sphinx.domains import Domain


	MD_DIR = 'md'
	SRC_URI_ROOT = (
	'https://chromium.googlesource.com/chromiumos/platform/factory/+/re'
	'fs/heads/main/')


	class MarkdownParser(CommonMarkParser):
	"""
	Custom parser for Markdown documents.
	"""

	supported = ['md', 'markdown']

	def parse(self, inputstring, document):
	path = document.current_source.split(MD_DIR, 1)[-1]
	path = path.lstrip('/')
	src_uri = os.path.join(SRC_URI_ROOT, path)

	# Add source code link in prolog
	prolog = f'source code: [{path}]({src_uri})\n\n'

	# The note syntax is not standard Markdown syntax, replace with bold font:
	# *** note
	# SOMTHING
	# ***
	# -> SOMETHING
	inputstring = re.sub(r'\\\* note \n(?P<text>.?)\n\\\*',
	r'\g<text>', inputstring, flags=re.DOTALL)
	super(MarkdownParser, self).parse(prolog + inputstring, document)


	class ChromiumURLDomain(Domain):
	"""
	Resolve certain links in markdown files to chromium source.
	"""

	name = 'chromiumurl'

	def resolve_any_xref(self, env, fromdocname, builder, target, node, contnode):
	uri = os.path.join('/'.join(fromdocname.split('/')[1:-1]), target)

	# recommonmark will auto trim .md in the links, check if the link refer
	# to a .md link not in the document page.
	#
	# If uri is a .md file, ignore the link and it will automatic refer to
	# the document page.
	if os.path.exists(os.path.join(MD_DIR, uri + '.md')):
	return []

	contnode['refuri'] = os.path.join(SRC_URI_ROOT, uri)
	return [(f'{self.name}:any', contnode)]


	# 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.
	py_pkg = os.getenv('CROS_FACTORY_PY_ROOT')
	if py_pkg is None:
	py_pkg = os.path.dirname(os.path.abspath(__file__))
	while py_pkg != '/' and not os.path.exists(os.path.join(py_pkg, 'py_pkg')):
	py_pkg = os.path.dirname(py_pkg)
	py_pkg = os.path.join(py_pkg, 'py_pkg')

	# We want to treat py/shopfloor as a standalone 'reference' folder without
	# importing it as module so there's no __init__.py and need to be explicitly
	# inserted into path for shopfloor_api.rst.
	py_shopfloor = os.path.join(py_pkg, 'cros', 'factory', 'shopfloor')

	assert os.path.exists(py_pkg), 'Failed to find py_pkg.'
	if py_pkg not in sys.path:
	sys.path.insert(0, py_pkg)
	if py_shopfloor not in sys.path:
	sys.path.insert(0, py_shopfloor)

	# -- 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.doctest', 'recommonmark',
	'cros.factory.doc.factory_docs'
	]

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

	# The suffix of source filenames.
	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 = 'CrOS Factory'

	# 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. We just use the current date as the version for now.
	version = time.strftime('%Y%m%d')
	# The full version, including alpha/beta/rc tags.
	release = version

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

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


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

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

	# 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 = ('%s %s documentation %s' % (
	project, version, os.environ.get('DOC_TITLE_SUFFIX', ''))).strip()

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

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

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

	# 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

	html_style = 'factory.css'

	# Output file base name for HTML help builder.
	htmlhelp_basename = 'factorydoc'


	# -- 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]).
	latex_documents = [
	('index', 'factory.tex', 'CrOS Factory Documentation', 'CrOS Factory',
	'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', 'factory', 'CrOS Factory Documentation', [
	'CrOS Factory'
	], 1)]

	# 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', 'factory', 'CrOS Factory Documentation', 'CrOS Factory',
	'factory', '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'

	autodoc_member_order = 'bysource'


	# app setup hook
	def setup(app):
	app.add_domain(ChromiumURLDomain)
	app.add_source_parser(MarkdownParser, override=True)