[TYPO3-doc] Meta data in conf.py

Philipp Gampe philipp.gampe at typo3.org
Sat Jun 16 12:23:12 CEST 2012


Hi François,

François Suter wrote:

> What solution should we aim for? What could be retrieved from Index.rst?
> 
> If we go for a Yaml file, should we really put it somewhere inside the
> "Documentation" folder or could it go into "Configuration/Settings.yaml"
> like a FLOW3 package? Or should it rather be XML data in
> "Meta/Package.xml", again à la FLOW3?

I would put the file into the Documentation folder and give it a speaking 
name. The Documentation folder should then mainly contain the Index.rst, 
this config file and folders for the chapters as included into the 
Index.rst.

BTW, Meta/Package.xml will be removed soon in favor of a composer compatible 
solution (PSR-0):
http://lists.typo3.org/pipermail/flow3-team-core/2012-June/000095.html

IMHO the documentation should be decoupled from the rest of the package.

Cheers
-- 
Philipp Gampe – PGP-Key 0AD96065 – TYPO3 UG Bonn/Köln
Documentation – linkvalidator
TYPO3 .... inspiring people to share!



More information about the TYPO3-project-documentation mailing list