Skip to content
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

Allow 'self' as special entry for root document #86

Open
kai-tub opened this issue Nov 1, 2022 · 1 comment
Open

Allow 'self' as special entry for root document #86

kai-tub opened this issue Nov 1, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@kai-tub
Copy link

kai-tub commented Nov 1, 2022

Context

Hey, I am using this project to manage my furo-based documentation site.
I like it to have a single ToC file that makes it easy to modify the structure and not having to manually edit many sub-tocs.

Like in the sphinx-external-toc documentation I would like to have a separate entry for the landing page; see the discussion over at furo.
The 'Sphinx' way would be to add the special entry self to the toctree call.
From the Sphinx configuration example:

The special entry name self stands for the document containing the toctree directive. This is useful if you want to generate a “sitemap” from the toctree.

From looking at the code of this site, it seems like this particular implementation is solved as an HTML theme option.

Proposal

I am not too familiar with how this library generates the toctree for Sphinx.
Maybe it is possible to reserve self as a special argument to refer to root?
I don't think that this should be an issue for non-root entries, as they are configured via separate entry options.
Only the root document would need to be able to refer to itself to register it as an entry.

Tasks and updates

I also understand that this is a low-priority feature, as the main targets are the executable books project.
But, at least from my viewpoint, it would be a nice feature for this project :)

@kai-tub kai-tub added the enhancement New feature or request label Nov 1, 2022
@welcome
Copy link

welcome bot commented Nov 1, 2022

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant