module helpgen._single_file_html_builder

Inheritance diagram of pyquickhelper.helpgen._single_file_html_builder

Short summary

module pyquickhelper.helpgen._single_file_html_builder

Copy of singlehtml.py

Single HTML builders.

copyright:

Copyright 2007-2020 by the Sphinx team, see AUTHORS.

license:

BSD, see LICENSE for details.

source on GitHub

Classes

class

truncated documentation

CustomSingleFileHTMLBuilder

A StandaloneHTMLBuilder subclass that puts the whole document tree on one HTML page.

Properties

property

truncated documentation

default_translator_class

math_renderer_name

Static Methods

staticmethod

truncated documentation

write_additional_files

Methods

method

truncated documentation

_get_local_toctree

assemble_doctree

assemble_toc_fignumbers

assemble_toc_secnumbers

finish

fix_refuris

get_doc_context

get_outdated_docs

get_relative_uri

get_target_uri

write

Documentation

Copy of singlehtml.py

Single HTML builders.

copyright:

Copyright 2007-2020 by the Sphinx team, see AUTHORS.

license:

BSD, see LICENSE for details.

source on GitHub

class pyquickhelper.helpgen._single_file_html_builder.CustomSingleFileHTMLBuilder(app: Sphinx, env: BuildEnvironment | None = None)[source]

Bases: StandaloneHTMLBuilder

A StandaloneHTMLBuilder subclass that puts the whole document tree on one HTML page.

source on GitHub

_get_local_toctree(docname: str, collapse: bool = True, **kwargs: Any) → str[source]
epilog = 'The HTML page is in %(outdir)s.'[source]

The message emitted upon successful build completion. This can be a printf-style template string with the following keys: outdir, project

finish() → None[source]

Finish the building process.

The default implementation does nothing.

get_doc_context(docname: str, body: str, metatags: str) → Dict[source]

Collect items for the template context of a page.

get_outdated_docs()[source]

Return an iterable of output files that are outdated, or a string describing what an update build will build.

If the builder does not output individual files corresponding to source files, return a string here. If it does, return an iterable of those files that need to be written.

get_relative_uri(from_: str, to: str, typ: str | None = None) → str[source]

Return a relative URI between two source filenames.

May raise environment.NoUri if there’s no way to return a sensible URI.

get_target_uri(docname: str, typ: str | None = None) → str[source]

Return the target URI for a document name.

typ can be used to qualify the link characteristic for individual builders.

name = 'singlehtml'[source]

The builder’s name, for the -b command line option.