Use ReadTheDocs service for documentation

stecman / symfony-console-completion

Automatic tab-key completion for Symfony console application options, arguments and parameters

MIT License

421 stars 26 forks source link

Use ReadTheDocs service for documentation #29

Closed aik099 closed 9 years ago

aik099 commented 9 years ago

The https://readthedocs.org/ service allows to host documentation with Sphinx search abilities. I recommend using it instead of writing long README.md.

Examples:

http://phpunit-mink.readthedocs.org/en/latest/getting-started.html
http://mink.behat.org/en/latest/

stecman commented 9 years ago

I'm not too keen on using ReadTheDocs for this library at the moment, as the readme is fairly straight forward and short(ish). I'll close this for now, but ReadTheDocs will definitely be the first choice if the documentation gets any more complicated.