doxysphinx.process
==================

.. py:module:: doxysphinx.process

.. autoapi-nested-parse::

   The process module contains the :class:`Builder` and :class:`Cleaner` classes.

   These represent the main functionality of doxysphinx.



Classes
-------

.. autoapisummary::

   doxysphinx.process.Builder
   doxysphinx.process.Cleaner


Module Contents
---------------

.. py:class:: Builder(sphinx_source_dir: pathlib.Path, sphinx_output_dir: pathlib.Path, dir_mapper_type: Type[doxysphinx.sphinx.DirectoryMapper] = SphinxHtmlBuilderDirectoryMapper, resource_provider_type: Type[doxysphinx.resources.ResourceProvider] = DoxygenResourceProvider, parser_type: Type[doxysphinx.html_parser.HtmlParser] = DoxygenHtmlParser, writer_type: Type[doxysphinx.writer.Writer] = RstWriter, force_recreation: bool = False, parallel=True)

   The Builder builds target docs-as-code files out of an existing html documentation.

   For each an every html file a rst file is created that imports the html content
   with raw directives. The html resources (stylesheets, images etc.) are also processed
   and copied to the correct place in the sphinx output directory.
   When sphinx then (later - not part of doxysphinx) processes the rst files they will
   resemble the original filenames in the sphinx output directory, thereby keeping
   and internal links intact.


   .. py:method:: build(doxygen_html_dir: pathlib.Path)

      Generate a rst file for each doxygen html file.

      Also copies necessary resources.

      :param doxygen_html_dir: The html output directory of doxygen where the
                               generated documentation is.



.. py:class:: Cleaner(sphinx_source_dir: pathlib.Path, sphinx_output_dir: pathlib.Path, dir_mapper_type: Type[doxysphinx.sphinx.DirectoryMapper] = SphinxHtmlBuilderDirectoryMapper, resource_provider_type: Type[doxysphinx.resources.ResourceProvider] = DoxygenResourceProvider, parallel: bool = True)

   The cleaner cleans files created and copied by the builder.


   .. py:method:: cleanup(doxygen_html_dir: pathlib.Path)

      Clean up files that were generated by the build method.

      :param doxygen_html_dir: The html output directory of doxygen where the
          generated documentation is.



