Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Generating online HTML from PHP Doc for Magento 2 #1011
The complete suite of Magento developer documentation will consist of content from multiple sources. There are guides that the documentation writing team are developing (such as at http://devdocs.magento.com), more traditional online documentation generated from PHP Doc comments, and potentially other automatically generated documentation on REST/SOAP APIs and similar.
This issue is an invitation for the community to help with the PHP Doc aspect of documentation generation. There are several aspects to this work:
In general, the goal is to get something up relatively quickly and deliver a useful short term result, restricted to PHP Doc. To set expectations, it may be this tool is temporary until replaced by a more encompassing solution for all documentation.
The goal is to lower the barrier to people exploring the Magento 2 code base today. Once the PHP Doc documentation is published, a desirable side effect is to then encourage greater contribution to improve the quality of the PHP Doc comments within the code base.
I tried the last night to generate docs with sami (https://github.com/FriendsOfPHP/Sami). The Project support to filter the output via tags. Also you can style the hole documentation via Twig. BUT :-( if i use the filter SymfonyFilter i get errors and nothing is generated. The default filter works. Here my config file if someone else can resolve the problem (https://gist.github.com/daim2k5/f963c98db70a5731a87b).
Error was PHP Fatal error: Call to a member function getName() on a non-object in /mage2docgenerator/vendor/sami/sami/Sami/Console/Command/Command.php on line 152
Hi, I tried to generate docs with phpDocumentor yesterday.
phpDocumentor version 2.8.5
It started from yesterday about 12:30, and this morning (about 7:00)when I went to check it has finished.
The phpdoc file is 8.63G, and have no chart of course.
Thank you for your submission.
We recently made some changes to the way we process GitHub submissions to more quickly identify and respond to core code issues.
We are closing this GitHub ticket and have moved your request to the new forum.
Hi! For the time being you can checkout my "magento2-api-doc" repo.
It holds the whole class library documentation (generated from source code) for Magento CE (Community Edition) 2.1.0 GA release.
Magento 2.1.0 was downloaded with composer, and the "ROOT/vendor/magento" folder has been processed for API documentation by the "Sami" API doc generator.