phpDocumentor

References

The Guide component was introduced as an experimental feature in phpDocumentor 3.1.
This feature is EXPERIMENTAL. None of the features nor the API should be considered stable and
may change without notice. There is no backwards compatibility promise for this part of the code
as it is highly in development.

One of the key features of a well written documentation set are links to navigate between sections in your documentation. This page describes the by phpDocumentor supported references. Those references allow you to link to different parts of your documentation set or even between documentation sets when you have multiple sets.

Doc

Most used links you create in Guides are refering to other pages or sections of your documentation. ReStructuredText supports multiple formats of links. But most common used is the notation below.

:doc:`Title of your page`

The code above will search full documentation for the given title Title of your page. and automatically create a link to this page. The downside of this, your titles have to be unique to be able to link to a specific document. In large projects it will be nearly impossible to do this.

:ref:`Configuration`

Search results