Skip to content

Smarter detection of toctree elements #135

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.

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

Closed
javiereguiluz opened this issue Dec 20, 2021 · 1 comment
Closed

Smarter detection of toctree elements #135

javiereguiluz opened this issue Dec 20, 2021 · 1 comment

Comments

@javiereguiluz
Copy link
Collaborator

Related to this: symfony/symfony-docs#16302

In Sphinx we could do this:

Learn more
----------
.. toctree::
    :maxdepth: 1
    :glob:

    /console
    /components/console/*
    /components/console/helpers/index
    /console/*

Sphinx recognizes that you have added /components/console/helpers/index explicitly and then it doesn't include it repeatedly in /components/console/*

When using Docs Builder, we must do this change:

 Learn more
 ----------
 .. toctree::
     :maxdepth: 1
     :glob:

     /console
     /components/console/*
-    /components/console/helpers/index
     /console/*

This is not an essential feature, but it's nice when you want to include some specific article behind all the other articles.

@javiereguiluz
Copy link
Collaborator Author

Let's close this issue because we haven't faced this problem again. It was just a single occurrence, so it's fine. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant