Inheritance diagram for devhelp.DevhelpBuilder:

Collaboration diagram for devhelp.DevhelpBuilder:

Public Member Functions
None	init (self)

None	handle_finish (self)

None	build_devhelp (self, str\|os.PathLike[str] outdir, str outname)

Public Member Functions inherited from sphinx.builders.html.StandaloneHTMLBuilder
None	__init__ (self, Sphinx app, BuildEnvironment env)

BuildInfo	create_build_info (self)

tuple[str, dict[str, str\|int\|bool]]	get_theme_config (self)

None	init_templates (self)

None	init_highlighter (self)

list[_CascadingStyleSheet]	css_files (self)

None	init_css_files (self)

None	add_css_file (self, str filename, **Any kwargs)

list[_JavaScript]	script_files (self)

None	init_js_files (self)

None	add_js_file (self, str filename, **Any kwargs)

str\|None	math_renderer_name (self)

Iterator[str]	get_outdated_docs (self)

list[str]	get_asset_paths (self)

dict[str, str]	render_partial (self, Node\|None node)

None	prepare_writing (self, Set[str] docnames)

dict[str, Any]	get_doc_context (self, str docname, str body, str metatags)

None	copy_assets (self)

None	write_doc (self, str docname, nodes.document doctree)

None	write_doc_serialized (self, str docname, nodes.document doctree)

None	finish (self)

None	gen_indices (self)

None	gen_pages_from_extensions (self)

None	gen_additional_pages (self)

None	write_genindex (self)

None	write_domain_indices (self)

None	copy_image_files (self)

None	copy_download_files (self)

None	create_pygments_style_file (self)

None	copy_translation_js (self)

None	copy_stemmer_js (self)

None	copy_theme_static_files (self, dict[str, Any] context)

None	copy_html_static_files (self, dict[str, Any] context)

None	copy_html_logo (self)

None	copy_html_favicon (self)

None	copy_static_files (self)

None	copy_extra_files (self)

None	write_buildinfo (self)

None	cleanup (self)

None	post_process_images (self, Node doctree)

None	load_indexer (self, Set[str] docnames)

None	index_page (self, str pagename, nodes.document doctree, str title)

Path	get_output_path (self, str page_name)

_StrPath	get_outfilename (self, str pagename)

None	add_sidebars (self, str pagename, dict[str, Any] ctx)

str	get_target_uri (self, str docname, str\|None typ=None)

None	handle_page (self, str pagename, dict[str, Any] addctx, str templatename='page.html', *Path\|None outfilename=None, Any event_arg=None)

None	update_page_context (self, str pagename, str templatename, dict[str, Any] ctx, Any event_arg)

None	dump_inventory (self)

None	dump_search_index (self)

Public Member Functions inherited from sphinx.builders.Builder
type[nodes.NodeVisitor]	get_translator_class (self, *Any args)

nodes.NodeVisitor	create_translator (self, *Any args)

None	create_template_bridge (self)

str	get_relative_uri (self, str from_, str to, str\|None typ=None)

None	compile_catalogs (self, set[CatalogInfo] catalogs, str message)

None	compile_all_catalogs (self)

None	compile_specific_catalogs (self, Iterable[Path] specified_files)

None	compile_update_catalogs (self)

None	build_all (self)

None	build_specific (self, Sequence[Path] filenames)

None	build_update (self)

None	build (self, Iterable[str]\|None docnames, str\|None summary=None, Literal['all', 'specific', 'update'] method='update')

list[str]	read (self)

None	read_doc (self, str docname, *bool _cache=True)

None	write_doctree (self, str docname, nodes.document doctree, *bool _cache=True)

None	write (self, Iterable[str]\|None build_docnames, Iterable[str] updated_docnames, Literal['all', 'specific', 'update'] method='update')

None	write_documents (self, Set[str] docnames)

Any	get_builder_config (self, str option, str default)

Public Attributes
	out_suffix

	link_suffix

	outdir

Public Attributes inherited from sphinx.builders.html.StandaloneHTMLBuilder
	build_info

	imagedir

	out_suffix

	link_suffix

	use_index

	config

	tags

	theme

	theme_options

	highlighter

	dark_highlighter

	indexer

	env

	docwriter

	domain_indices

	relations

	globalcontext

	embedded

	name

	copy_download_files

	copy_static_files

	copy_extra_files

	secnumbers

	fignumbers

	imgpath

	dlpath

	current_docname

	gen_indices

	gen_pages_from_extensions

	gen_additional_pages

	copy_image_files

	write_buildinfo

	images

	srcdir

	outdir

	indexer_format

	dump_search_index

	dump_inventory

Public Attributes inherited from sphinx.builders.Builder
	versioning_method

	versioning_compare

	format

	name

	imagedir

	imgpath

	parallel_ok

	templates

	app

	env

	finish_tasks

	config

Static Public Attributes
str	name = 'devhelp'

	epilog

bool	copysource = False

list	supported_image_types = ['image/png', 'image/gif', 'image/jpeg']

bool	add_permalinks = False

bool	embedded = True

Static Public Attributes inherited from sphinx.builders.html.StandaloneHTMLBuilder
str	name = 'html'

str	format = 'html'

	epilog = __('The HTML pages are in %(outdir)s.')

	default_translator_class = HTML5Translator

bool	copysource = True

bool	allow_parallel = True

str	out_suffix = '.html'

str	link_suffix = '.html'

Any	indexer_format = js_index

bool	indexer_dumps_unicode = True

bool	html_scaled_image_link = True

list	supported_image_types = ['image/svg+xml', 'image/png', 'image/gif', 'image/jpeg']

bool	supported_remote_images = True

bool	supported_data_uri_images = True

str	searchindex_filename = 'searchindex.js'

bool	add_permalinks = True

bool	allow_sharp_as_current_path = True

bool	embedded = False

bool	search = True

bool	use_index = False

bool	download_support = True

str	imgpath = ''

list	domain_indices = []

Static Public Attributes inherited from sphinx.builders.Builder
str	name = ''

str	format = ''

str	epilog = ''

type	default_translator_class [nodes.NodeVisitor]

str	versioning_method = 'none'

bool	versioning_compare = False

bool	allow_parallel = False

bool	use_message_catalog = True

list	supported_image_types = []

bool	supported_remote_images = False

bool	supported_data_uri_images = False

	srcdir = _StrPathProperty()

	confdir = _StrPathProperty()

	outdir = _StrPathProperty()

	doctreedir = _StrPathProperty()

Additional Inherited Members
Protected Member Functions inherited from sphinx.builders.html.StandaloneHTMLBuilder
Path\|None	_get_translations_js (self)

Iterator[str]	_get_style_filenames (self)

str	_get_local_toctree (self, str docname, bool collapse=True, **Any kwargs)

Protected Member Functions inherited from sphinx.builders.Builder
NullTranslations\|None	_translator (self)

None	_read_serial (self, list[str] docnames)

None	_read_parallel (self, list[str] docnames, int nproc)

None	_write_serial (self, Sequence[str] docnames)

None	_write_parallel (self, Sequence[str] docnames, int nproc)

Protected Attributes inherited from sphinx.builders.html.StandaloneHTMLBuilder
	_static_dir

	_sources_dir

	_downloads_dir

	_images_dir

	_publisher

	_css_files

	_js_files

	_orig_css_files

	_orig_js_files

Detailed Description

Builder that also outputs GNOME Devhelp file.

Member Function Documentation

◆ handle_finish()

None devhelp.DevhelpBuilder.handle_finish ( self )

Reimplemented from sphinx.builders.html.StandaloneHTMLBuilder.

◆ init()

None devhelp.DevhelpBuilder.init ( self )

Load necessary templates and perform initialization.  The default
implementation does nothing.

Reimplemented from sphinx.builders.html.StandaloneHTMLBuilder.

Member Data Documentation

◆ epilog

devhelp.DevhelpBuilder.epilog

static

Initial value:

=  __('To view the help file:\n'
                '$ mkdir -p $HOME/.local/share/devhelp/books\n'
                '$ ln -s $PWD/%(outdir)s $HOME/.local/share/devhelp/books/%(project)s\n'
                '$ devhelp')

The documentation for this class was generated from the following file:

docs/help/help-venv/lib/python3.12/site-packages/sphinxcontrib/devhelp/__init__.py

Public Member Functions

Public Attributes