Automatic Intersphinx mapping
The reference browser already lets the editor easily cross-link to other extension manuals or official documents. However it does not support the TYPO3 API coming from Doxygen that allows one to cross-link to the source code of TYPO3 (either classes or methods - and a few other pages).
To cross-link to the TYPO3 source code, one has to manually add an Intersphinx reference:
conf.py copyright: 2013 project: Your project version: 1.0 release: 1.0.0 intersphinx_mapping: t3cmsapi: - http://typo3.org/api/typo3cms/ - null
to be able to write, e.g.,
This is not the sole use case. If you insert a cross-link to some extension manual, an AJAX request silently updates your Intersphinx mapping so that rendering will succeed. But if your
Settings.yml is read-only, then this update does not work and the rendering will fail with something like that in
/path/to/Index.rst:11: WARNING: undefined label: myextkey:start (if the link has no caption the label must precede a section header)
Taking for granted that the user always sticks to our conventions, we could assume that "myextkey" (or in our first case "t3cmsapi") are extension key/official documentation key and dynamically update the Intersphinx mapping either for the current rendering (if
Settings.yml is still readonly) or in the actual
Settings.yml from sources. This would be similar to #51874 for missing Sphinx-Doc extensions.
Discussion about cross-linking to Doxygen: http://forum.typo3.org/index.php?t=msg&th=198766&goto=693266&#msg_693266