Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add support for the "contents" directive #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
javiereguiluz opened this issue Sep 8, 2021 · 3 comments
Closed

Add support for the "contents" directive #113

javiereguiluz opened this issue Sep 8, 2021 · 3 comments

Comments

@javiereguiluz
Copy link
Collaborator

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.
@wouterj
Copy link
Contributor

wouterj commented Sep 8, 2021

I think it's worth adding support for this directive (I introduced it in the docs 😄 ), as I quite like this sub-TOCs (especially since we limit the main TOC to 2 levels, which makes a lot of sense).

This was referenced Jan 17, 2022
Merged
Closed
@jdreesen
Copy link

Sounds like a great idea for e.g. this page: https://symfony.com/doc/current/reference/configuration/framework.html

@javiereguiluz
Copy link
Collaborator Author

Let's close this issue. It's been more than 2 years since it was created. We didn't receive any feedback, nobody tried to implement this and, more importantly, we never needed it in Symfony Docs. I think it's better to focus our resources on other things that provide more value. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@javiereguiluz @jdreesen @wouterj