demcompare.sphinx_project_generator
===================================

.. py:module:: demcompare.sphinx_project_generator

.. autoapi-nested-parse::

   sphinx_project_generator was built for demcompare and its 'report' step.
   As so, it is designed for this simple purpose, meaning only light version of
   the Makefile and the conf.py are proposed, and no way to control them.
   If somehow required, this project generator shall be improved to offer some
   level of customization.



Attributes
----------

.. autoapisummary::

   demcompare.sphinx_project_generator.SPM


Classes
-------

.. autoapisummary::

   demcompare.sphinx_project_generator.SphinxProjectManager


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

.. py:class:: SphinxProjectManager(working_dir, output_dir, index_name, project_name)

   Sphinx Projet Manager Class
   Class to represent the Sphinx demcompare report
   and be able to ease its manipulation:
   create a sphinx project architecture + configuration
   + build and install project


   .. py:attribute:: _working_dir


   .. py:attribute:: _output_dir


   .. py:attribute:: _index_name


   .. py:attribute:: _project_name


   .. py:attribute:: _makefile
      :value: None



   .. py:attribute:: _confpy
      :value: None



   .. py:method:: _create_sphinx_project()

      Create project architecture and configuration :

      _working_dir/build/
      _working_dir/Makefile
      _working_dir/source/
      _working_dir/source/conf.py
      _working_dir/source/_index_name.rst

      :return:



   .. py:method:: _create_makefile()


   .. py:method:: _create_confpy()


   .. py:method:: write_body(body)

      Write report body in class file.

      :param body: body text



   .. py:method:: build_project(mode)

      Build project depending on mode.

      :param mode: 'html' or 'latex' or 'latexpdf'
      :return:



   .. py:method:: install_project()

      Method to install (copy from build) sphinx project in _output_dir



   .. py:method:: clean()
      :staticmethod:



.. py:data:: SPM