Skip to content

Fix some edge-case related to TOCs of docs without titles #114

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

Merged
merged 1 commit into from
Sep 14, 2021

Conversation

javiereguiluz
Copy link
Collaborator

In some symfony.com docs we have some partial docs that are included in other docs ... but instead of naming them as foo.rst.inc as in Symfony Docs, we name them as foo.rst. This included file is just a paragraph without any titles, so when trying to generate the TOC it fails.

@javiereguiluz javiereguiluz added the bug Something isn't working label Sep 13, 2021
Copy link
Contributor

@weaverryan weaverryan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Though, I think naming these "partials" with a .rst ending is weird - they would, I believe, be seen as "orphaned" documents in Sphinx.

@weaverryan weaverryan merged commit 1514b88 into symfony-tools:main Sep 14, 2021
@wouterj
Copy link
Contributor

wouterj commented Sep 14, 2021

Yeah, this should be named .rst.inc imho

@javiereguiluz javiereguiluz deleted the no_toc branch September 14, 2021 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Development

Successfully merging this pull request may close these issues.

3 participants