Skip to content

Add support for the "contents" directive #113

Closed
@javiereguiluz

Description

@javiereguiluz

While generating Symfony Docs I found this error:

Unknown directive: "contents" in "testing" for line ".. contents::"

It's because in this file --> https://raw.githubusercontent.com/symfony/symfony-docs/4.4/testing.rst

we have things like this:

.. contents::
    :local:
    :depth: 1

I didn't know this directive. Apparently, it's used to add TOCs in the middle of some doc with the headings of the sections below this directive (http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents).

So, should we add support for this directive (which is used very rarely in our docs) or should we reword our docs to remove it? Thanks.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions