doxysphinx.sphinx#
The sphinx module contains classes that are tied to sphinx or resemble sphinx logic.
Classes#
Mapper that will calculate the output file path for an input file. |
|
Mapper that will calculate the output file path for an input file. |
Module Contents#
- class doxysphinx.sphinx.DirectoryMapper(sphinx_source_dir: pathlib.Path, sphinx_output_dir: pathlib.Path)#
Bases:
digraph inheritance48331729fd { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "DirectoryMapper" [URL="#doxysphinx.sphinx.DirectoryMapper",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mapper that will calculate the output file path for an input file."]; "Protocol" -> "DirectoryMapper" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Generic" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled"]; "Protocol" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for protocol classes."]; "Generic" -> "Protocol" [arrowsize=0.5,style="setlinewidth(0.5)"]; }Protocol
Mapper that will calculate the output file path for an input file.
In docs-as-code tooling (e.g. sphinx) often files from a source dir structure are processed and written to result files in a target dir structure.
The make this mapping an implementation detail this protocol exists. It should be implemented for any special handling in mapping files.
- map(path: pathlib.Path) pathlib.Path #
Calculate the path in output for a given path in input.
- class doxysphinx.sphinx.SphinxHtmlBuilderDirectoryMapper(sphinx_source_dir: pathlib.Path, sphinx_output_dir: pathlib.Path)#
Mapper that will calculate the output file path for an input file.
This is based on the logic that the sphinx html builder would use.
- source#
- output#
- map(path: pathlib.Path) pathlib.Path #
Calculate the path in output for a given path in input.