.. image:: https://poser.pugx.org/phpdocumentor/guides/require/php
:alt: PHP Version Require
:target: https://packagist.org/packages/phpdocumentor/guides
.. image:: https://poser.pugx.org/phpdocumentor/guides/v/stable
:alt: Latest Stable Version
:target: https://packagist.org/packages/phpdocumentor/guides
.. image:: https://poser.pugx.org/phpdocumentor/guides/v/unstable
:alt: Latest Unstable Version
:target: https://packagist.org/packages/phpdocumentor/guides
.. image:: https://poser.pugx.org/phpdocumentor/guides/d/total
:alt: Total Downloads
:target: https://packagist.org/packages/phpdocumentor/guides
.. image:: https://poser.pugx.org/phpdocumentor/guides/d/monthly
:alt: Monthly Downloads
:target: https://packagist.org/packages/phpdocumentor/guides
====================
phpDocumentor Guides
====================
This repository is part of `phpDocumentor's Guides library <https://github.com/phpDocumentor/guides>`__, a framework
designed to take hand-written documentation in code repositories and create an AST (abstract syntax tree) from it.
This AST is then fed to a renderer, which produces the desired output, such as HTML.
The package `phpdocumentor/guides <https://packagist.org/packages/phpdocumentor/guides>`__ contains the core
functionality from the phpDocumentor Guides.
:Mono-Repository: https://github.com/phpDocumentor/guides
:Documentation: https://docs.phpdoc.org/components/guides/guides/index.html
:Packagist: https://packagist.org/packages/phpdocumentor/guides
:Contribution: https://github.com/phpDocumentor/guides/tree/main/CONTRIBUTING.rst
Attribution
===========
This repository was originally forked from the `Doctrine rst-parser <https://github.com/doctrine/rst-parser>`__,
and is based on the original code from `Gregwar <https://github.com/Gregwar/RST>`__.