You are browsing a version that is no longer maintained.
Maintained
1.0 (upcoming) 0.6 (upcoming) 0.5.6 (current)
Unmaintained
0.4 0.3 0.2 0.1 0.0

Builder

The Doctrine\RST\Builder class will parse a whole tree of documents and generate an output directory containing formatted files.

It can be used like this:

1use Doctrine\RST\Builder;

$builder = new Builder();
$builder->build('/path/to/source', '/path/to/output');


2


3


4

It will parse all the files in the /path/to/source directory, starting with index.rst, scan for dependencies and will generate target files in the /path/to/output directory. The Default format is HTML.

Configuration

If you want to customize the builder you can pass a Doctrine\RST\Kernel instance with a Doctrine\RST\Configuration that allows you to customize the configuration used by the builder:

1use Doctrine\RST\Builder;
use Doctrine\RST\Configuration;
use Doctrine\RST\Kernel;

$configuration = new Configuration();
$configuration->setBaseUrl('https://www.google.com');
$kernel = new Kernel($configuration);

$builder = new Builder($kernel);


2


3


4


5


6


7


8


9

You can read more about what configuration options exist in the Configuration chapter.

Custom Index Name

If your index file is not index.rst and it is something like introduction.rst you can customize that using the setIndexName() method:

1$builder->setIndexName('introduction');