ProcessManager

namespace

bhenk\doc2rst\process

predicates

Cloneable | Instantiable

Runs the transformation of source files to restructured text files

Constructor

ProcessManager::__construct

predicates

public | constructor

Constructs a new ProcessManager

The parameter doc_root is the absolute path to the documentation directory.
When calling from the phar file, optional parameter $root is the parent directory of the phar.

see also

RC for runtime configuration options

public function __construct(
      Parameter #0 [ <required> string $doc_root ]
      Parameter #1 [ <optional> ?string $root = NULL ]
 )
param string $doc_root - The documentation directory; autoconfiguration is computed from this directory.
param ?string $root - Optional. Parent directory of main.php

Methods

ProcessManager::quickStart

predicates

public

Quickstart doc2rst

This function will scan the source directory known as vendor_directory. It will not generate rst-files, only suggest reasonable configuration options for file and directory paths. Furthermore, it will place configuration files in the doc_root directory. These configuration files are:

public function quickStart(): void
return void

ProcessManager::run

predicates

public

Run doc2rst and generate rst-files

If nothing goes wrong you will find api-documentation in the api_directory folder under your doc_root directory.

see also

RC for runtime configuration options

public function run(): void
return void

ProcessManager::getConstitution

predicates

public

Autoconfiguration is done by an implementation of ConstitutionInterface

At the moment there is only one implementation: Constitution. If necessary write your own Constitution!

public function getConstitution(): ConstitutionInterface
return ConstitutionInterface

ProcessManager::setConstitution

predicates

public

Sets the Constitution used for autoconfiguration

public function setConstitution(
      Parameter #0 [ <required> bhenk\doc2rst\process\ConstitutionInterface $constitution ]
 ): void
param ConstitutionInterface $constitution
return void

Fri, 31 Mar 2023 13:22:46 +0000