diff --git a/docs/source/adding-mutant-generation.rst b/docs/source/adding-mutant-generation.rst index 3cd557e..b885343 100644 --- a/docs/source/adding-mutant-generation.rst +++ b/docs/source/adding-mutant-generation.rst @@ -1,2 +1,26 @@ Adding a Mutant Generation Approach =================================== + +To add a mutant generation approach to *multiplex*, users should create a package for their approach in the ``multiplex/approach/`` directory. + +Users can copy the ``basic`` example to get started and then build their own approach using the underlying setup. + +Each approach has a ``controller.py`` file that is called by ``multiplex/__main__.py``. +Currently users must add their approach call to ``__main__.py`` following the template of the existing approaches. + +.. code-block:: Python + + """Controller for Basic prompt approach.""" + + from approach.basic.code_generator import generate_code + + + def main(model, output_dir, prompts, language): + """Controller for Basic prompt approach""" + + generate_code(model, output_dir, prompts["basic_generate_mutants"], language) + + + def __main__(model, output_dir, prompts, language): + main(model, output_dir, prompts, language) + diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst deleted file mode 100644 index 3837742..0000000 --- a/docs/source/architecture.rst +++ /dev/null @@ -1,2 +0,0 @@ -Architecture -============ diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst deleted file mode 100644 index 6e79ebd..0000000 --- a/docs/source/configuration.rst +++ /dev/null @@ -1,2 +0,0 @@ -Configuration -=============