[TYPO3-doc] How to render the TYPO3 Flow rst Documentation as html?

Jan Greth jan at greth.me
Mon Feb 11 21:54:45 CET 2013


Good evening at all!

I asked my question on the flow.general-List and there they said I 
should ask in this list - so i'll do.

I'm trying and testing to render the rst Documentation of TYPO3 Flow... 
without success. Does anyone of you have a actual Tutorial of doing 
this? Or have some further tipps for me?
Any kind of help is wecome...

The steps I made till here;
My System:
	Ubuntu 20.04
	Apache 2, MySQL, PHP, ...
	Python 3

First found this:
http://lists.typo3.org/pipermail/flow3-team-core/2012-April/000082.html

But in my opinion it is outdated / dosen't work anymore. So tried to 
find other ways and found this Page: 
http://docs.typo3.org/flow/TYPO3FlowDocumentation/TheDefinitiveGuide/PartV/ContributingToTYPO3Flow.html

With the following steps:

If you like to see a rendered HTML result [...]
Use any installed TYPO3 Flow distribution. If you don't have TYPO3 Flow 
installed, install the Base 		distribution as described in the 
Installation section of the Getting Started chapter.

	-> Did it, via composer as described in Quickstart
	
Set up GIT for use with gerrit (our git wizard might help with that).

	-> Don't think ill need it, cause just need the HTML -
	don't want to push in next future - I'm too new with this...
	
Install Sphinx to render the documentation.

	-> Done via "sudo easy_install Sphinx"
	-> Also installed prequisites as described under:
	 http://sphinx-doc.org/intro.html#prerequisites
	
Import and activate the package TYPO3.DocTools. It provides you with a 
command to render standalone documentation.

	-> Did it by using
	cd /var/www/flow/Packages/Framework/ (Flow Base Folder)
	git clone git://git.typo3.org/FLOW3/Packages/TYPO3.DocTools.git
	
$ ./flow documentation:render --format html
Read the documentation and adjust it as needed [...]

	-> But when I type it I get:
	->
jan at ubuntu:/var/www/flow$ ./flow documentation:render --format html
PHP Fatal error:  Uncaught exception 
'TYPO3\Flow\Package\Exception\InvalidPackageStateException' with message 
'Could not find package with composer name "typo3/neos" in PackageStates 
configuration.' in 
/var/www/flow/Packages/Framework/TYPO3.Flow/Classes/TYPO3/Flow/Package/PackageManager.php:304
Stack trace:
#0 
/var/www/flow/Packages/Framework/TYPO3.Flow/Classes/TYPO3/Flow/Package/Package.php(155): 
TYPO3\Flow\Package\PackageManager->getPackageKeyFromComposerName('typo3/neos')
#1 
/var/www/flow/Packages/Framework/TYPO3.Flow/Classes/TYPO3/Flow/Package/PackageManager.php(875): 
TYPO3\Flow\Package\Package->getPackageMetaData()
#2 
/var/www/flow/Packages/Framework/TYPO3.Flow/Classes/TYPO3/Flow/Package/PackageManager.php(852): 
TYPO3\Flow\Package\PackageManager->getDependencyArrayForPackage('TYPO3.DocTools')
#3 
/var/www/flow/Packages/Framework/TYPO3.Flow/Classes/TYPO3/Flow/Package/PackageManager.php(896): 
TYPO3\Flow\Package\PackageManager->resolvePackageDependencies()
#4 /var/www/flow/Packages/Framework/TYPO3.Flow/Classes/TYPO3/Flow/Pack 
in 
/var/www/flow/Packages/Framework/TYPO3.Flow/Classes/TYPO3/Flow/Package/PackageManager.php 
on line 304


What can I do? Is it possible that I also have to install Neos just for 
rendering the Flow Docu???


Yours,
Jan


More information about the TYPO3-project-documentation mailing list