sphinx.builders.dirhtml.DirectoryHTMLBuilder

class documentation

class DirectoryHTMLBuilder(StandaloneHTMLBuilder):

View In Hierarchy

A StandaloneHTMLBuilder that creates all HTML pages as "index.html" in a directory given by their pagename, so that generated URLs don't have .html in them.
Class Variable name Undocumented
Method get​_outfilename Undocumented
Method get​_target​_uri Return the target URI for a document name.

Inherited from StandaloneHTMLBuilder:

Class Variable format Undocumented
Class Variable supported​_image​_types Undocumented
Method __init__ Undocumented
Method ​_get​_local​_toctree Undocumented
Method ​_get​_style​_filename Undocumented
Method ​_get​_translations​_js Undocumented
Method add​_css​_file Undocumented
Method add​_js​_file Undocumented
Method add​_sidebars Undocumented
Method cleanup Cleanup any resources.
Method copy​_download​_files Undocumented
Method copy​_extra​_files copy html_extra_path files.
Method copy​_html​_favicon Undocumented
Method copy​_html​_logo Undocumented
Method copy​_html​_static​_files Undocumented
Method copy​_image​_files Undocumented
Method copy​_static​_files Undocumented
Method copy​_stemmer​_js Copy a JavaScript file for stemmer.
Method copy​_theme​_static​_files Undocumented
Method copy​_translation​_js Copy a JavaScript file for translations.
Method create​_build​_info Undocumented
Method create​_pygments​_style​_file create a style file for pygments.
Method dump​_inventory Undocumented
Method dump​_search​_index Undocumented
Method finish Finish the building process.
Method gen​_additional​_pages Undocumented
Method gen​_indices Undocumented
Method gen​_pages​_from​_extensions Undocumented
Method get​_asset​_paths Return list of paths for assets (ex. templates, CSS, etc.).
Method get​_doc​_context Collect items for the template context of a page.
Method get​_outdated​_docs Return an iterable of output files that are outdated, or a string describing what an update build will build.
Method get​_theme​_config Undocumented
Method handle​_finish Undocumented
Method handle​_page Undocumented
Method index​_page Undocumented
Method init Load necessary templates and perform initialization. The default implementation does nothing.
Method init​_css​_files Undocumented
Method init​_highlighter Undocumented
Method init​_js​_files Undocumented
Method init​_templates Undocumented
Method load​_indexer Undocumented
Method post​_process​_images Pick the best candidate for an image and link down-scaled images to their high res version.
Method prepare​_writing A place where you can add logic before write_doc is run
Method render​_partial Utility: Render a lone doctree node.
Method update​_page​_context Undocumented
Method write​_buildinfo Undocumented
Method write​_doc Where you actually write something to the filesystem.
Method write​_doc​_serialized Handle parts of write_doc that must be called in the main process if parallel build is active.
Method write​_domain​_indices Undocumented
Method write​_genindex Undocumented
Class Variable add​_permalinks Undocumented
Class Variable allow​_parallel Undocumented
Class Variable allow​_sharp​_as​_current​_path Undocumented
Class Variable copysource Undocumented
Class Variable download​_support Undocumented
Class Variable embedded Undocumented
Class Variable epilog Undocumented
Class Variable html​_scaled​_image​_link Undocumented
Class Variable indexer​_dumps​_unicode Undocumented
Class Variable search Undocumented
Class Variable searchindex​_filename Undocumented
Class Variable supported​_data​_uri​_images Undocumented
Class Variable supported​_remote​_images Undocumented
Instance Variable ​_css​_files Undocumented
Instance Variable ​_script​_files Undocumented
Instance Variable build​_info Undocumented
Instance Variable css​_files Undocumented
Instance Variable current​_docname Undocumented
Instance Variable dark​_highlighter Undocumented
Instance Variable dlpath Undocumented
Instance Variable docsettings Undocumented
Instance Variable docwriter Undocumented
Instance Variable domain​_indices Undocumented
Instance Variable fignumbers Undocumented
Instance Variable globalcontext Undocumented
Instance Variable highlighter Undocumented
Instance Variable imagedir Undocumented
Instance Variable imgpath Undocumented
Instance Variable indexer Undocumented
Instance Variable last​_updated Undocumented
Instance Variable link​_suffix Undocumented
Instance Variable out​_suffix Undocumented
Instance Variable relations Undocumented
Instance Variable script​_files Undocumented
Instance Variable secnumbers Undocumented
Instance Variable theme Undocumented
Instance Variable theme​_options Undocumented
Instance Variable use​_index Undocumented
Property default​_translator​_class Undocumented
Property math​_renderer​_name Undocumented

Inherited from Builder (via StandaloneHTMLBuilder):

Method build Main build method.
Method build​_all Build all source files.
Method build​_specific Only rebuild as much as needed for changes in the filenames.
Method build​_update Only rebuild what was changed or added since last build.
Method get​_relative​_uri Return a relative URI between two source filenames.
Instance Variable events Undocumented
Method ​_read​_parallel Undocumented
Method ​_read​_serial Undocumented
Method ​_write​_parallel Undocumented
Method ​_write​_serial Undocumented
Method compile​_all​_catalogs Undocumented
Method compile​_catalogs Undocumented
Method compile​_specific​_catalogs Undocumented
Method compile​_update​_catalogs Undocumented
Method create​_template​_bridge Return the template bridge configured.
Method create​_translator Return an instance of translator.
Method get​_builder​_config Return a builder specific option.
Method get​_translator​_class Return a class of translator.
Method read (Re-)read all files new or changed since last update.
Method read​_doc Parse a file and add/update inventory entries for the doctree.
Method set​_environment Store BuildEnvironment object.
Method write Undocumented
Method write​_doctree Write the doctree to a file.
Class Variable use​_message​_catalog Undocumented
Class Variable versioning​_compare Undocumented
Class Variable versioning​_method Undocumented
Instance Variable app Undocumented
Instance Variable confdir Undocumented
Instance Variable config Undocumented
Instance Variable doctreedir Undocumented
Instance Variable env Undocumented
Instance Variable finish​_tasks Undocumented
Instance Variable images Undocumented
Instance Variable outdir Undocumented
Instance Variable parallel​_ok Undocumented
Instance Variable srcdir Undocumented
Instance Variable tags Undocumented
Instance Variable templates Undocumented
name: str =
overrides sphinx.builders.html.StandaloneHTMLBuilder.name

Undocumented

def get_outfilename(self, pagename):
overrides sphinx.builders.html.StandaloneHTMLBuilder.get_outfilename

Undocumented

Parameters
pagename:strUndocumented
Returns
strUndocumented
def get_target_uri(self, docname, typ=None):
overrides sphinx.builders.html.StandaloneHTMLBuilder.get_target_uri

Return the target URI for a document name.

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

Parameters
docname:strUndocumented
typ:strUndocumented
Returns
strUndocumented