Show projects README, TODO and/or INSTALL in documentation about phpdocumentor HOT 4 CLOSED

Would be nice if one could add more documents to that list via config :-)

from phpdocumentor.

Actually there is another issue open for the generation of user manuals; although I might be better of making an integration with, for example, Sphinx to do so

from phpdocumentor.

Adding a hearty +1 to this. We're just getting started with phpDocumentor and decided to try 2.0 out. It's pretty sweet! But alas, without the ability to include a manual / readme, we can't quite reach the dream of full documentation based entirely on the code.

Personally, we're using this for WordPress projects. It uses markdown (http://wordpress.org/extend/plugins/about/readme.txt). I started down the path of leveraging @markjaquith's readme parser to build an array of readme elements, but i'm not sure how to apply that to the phpDocumentor system so that phpDocumentor includes that.

https://github.com/markjaquith/WordPress-Plugin-Readme-Parser

I thought about doing this in a plugin but I'm honestly kind of lost about how to write a plugin for phpDocumentor.

Anyway, thanks for doing this work on phpDocumentor. It's WAY faster now and it's a lot more welcoming.

from phpdocumentor.

This is dealt with in issue #46; we are working on a solution where input using Markdown, ReST and some other markup languages is possible.

from phpdocumentor.