widmogrod/run-the-docs

Keep code and documentation in sync. Run code examples in a browser

dev-master 2017-12-28 21:33 UTC

Requires

• nikic/php-parser: ^3.1
• phpdocumentor/reflection-docblock: ^3.1
• symfony/console: ^3.2

Requires (Dev)

• phpunit/phpunit: ^5.7
• twig/twig: ~1.0

MIT

• widmogrod

README

Introduction

Keep code and documentation in sync. Run code examples in a browser.

Specificaton (Draft)

Core concepts

• Language agnostic. Generates documentation from any programming language.
• Code is documentation. Keeping documentation inlined in code makes it's easier to be in sync with actual state of the codebase.
• Examples are tests. Having examples as a test protects them from being outdate and therefore documentation from becoming obsolete.