You are browsing a version that has not yet been released.
Normally, all URLs are generated relative, but if you want to generate absolute URLs
with a base url, you can use the
In some cases, you may want to control when the base url gets used. For this you can set a callable that will be invoked when generating URLs. The callable receives a string that contains the path to the current file being rendered. This means you could make the parser only use the base url on certain paths:
By default if an error is encountered, the parsing will be aborted. You can easily change this like this:
By default, invalid references and links will be reported as errors. If you want to ignore them you can do so like this:
By default, the Doctrine RST Parser comes with two formats, HTML and LaTeX. HTML is the default format and you can configure which format to use by using the following constants:
And you can configure the format to render like this:
You can read more about formats in the Formats chapter.
By default, the outputted HTML is not indented consistently. If you would like the outputted HTML to be
indented consistently, you can enable this feature using the
setIndentHTML(bool $indentHTML) method:
This feature only works when rendering full HTML documents using the