The `load_xml_doc.py` module#

Summary#

Functions

`load_links`	Load all links.
`load_fcache`	Load all graphics and cache the base name without the extension.
`load_docu_global`	Load all global documents.
`load_terms`	Load all needed terms.

load_xml_doc.load_links(link_path: pathlib.Path) → dict#

Load all links.

Parameters:

Returns:

dict: Dictionary containing the link names and the needed information to render the links.

load_xml_doc.load_fcache(graph_path: pathlib.Path) → dict#

Load all graphics and cache the base name without the extension.

Parameters:

Returns:

dict: Dictionary containing the base names of the graphics and their path.

load_xml_doc.load_docu_global(term_path: pathlib.Path) → dict#

Load all global documents.

Parameters:

Returns:

dict: Dictionary containing the entity names from the documentation and their path.

load_xml_doc.load_terms(term_path: pathlib.Path, docu_global: dict, links: dict, fcache: dict, variable_file: str = 'build_variables.ent', global_terms_file: str = 'terms_global.ent', manual_file: str = 'manuals.ent', group_code_file: str = '../xml/ansys.groupcodes.commands.ent', character_directory: str = 'ent') → Tuple[dict, pyconverter.xml2py.version_variables.Autogenerateddirectory]#

Load all needed terms.

Parameters:

term_path: Path: Path object of the terms directory.
docu_global: dict: Dictionary containing the entity names from the documentation and their path.
links: dict: Dictionary containing the link names and the needed information to render the links.
fcache: dict: Dictionary containing the base names of the graphics and their path.
variable_file: str, optional: Name of the file containing the variable terms to import. The default value is "build_variables.ent".
global_terms_file: str, optional: Name of the file containing the global terms to import. The default is "terms_global.ent".
manual_file: str, optional: Name of the file containing the manual entities to import. The default is "manuals.ent".
character_directory: str, optional: Name of the directory containg the entities for the special characters. The default is "ent".

Returns:

dict: Dictionary containing the entity names and their values.
Autogenerateddirectory: Object containing the version variables of the XML documentation.