This should be parsed differently by the docs-builder @weaverryan

This should be parsed differently by the docs-builder @weaverryan

Do you think it's a parsing issue ? Syntax seems to be incomplete regarding others todo block

Do you think it's a parsing issue ? Syntax seems to be incomplete regarding others todo block

Yes, because before, when we use Sphinx to render the docs, this todo was not rendered, now while using the new symfony-tools/docs-builder it shows up...

cc @nikophil

Hello,

the problem comes from the rst parser.

rst language reference says comments could look like this, which works with the parser:

.. This is a comment

or this, which is not considered as a comment and is a bug in the parser

..
    this is a comment

they don't give an example for this kind of block (not even in sphinx doc)

.. first comment
    still a comment in the same block

but they do provide a "syntax diagram" which makes me think this should also be considered as a comment:

+-------+----------------------+
| ".. " | comment              |
+-------+ block                |
        |                      |
        +----------------------+

Still, if Sphynx did consider the later as a block comment, maybe this behavior could land in the parser as well.
Moreover, the way that GitHub and PHPStorm highlights the syntax proves this kind of "comment block" should be handled by the parser:

.. I am a comment and appear in grey
   I am also in grey, so I am a comment
I am not in grey, because I am not a comment

I've open a PR the rst repository
doctrine/rst-parser#220

PR is merged, let's wait for them to release the patch 😊

@OskarStark @weaverryan The PR has been released in 0.5.3
I don't know how the release of the docs builder is made (a phar creation I guess....).
But upgrading the rst parser inside de docs builder will fix this issue

Thanks Matthieu.

@nikophil thanks! I've tagged a new version of symfony/docs-builder too, so we'll get your latest fixes.