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

Improve menu generation #617

Merged
merged 1 commit into from
Sep 26, 2024
Merged

Improve menu generation #617

merged 1 commit into from
Sep 26, 2024

Conversation

jaapio
Copy link
Contributor

@jaapio jaapio commented Sep 25, 2024

So the origin of the menu's not working is in the way the menu's are defined. The doctrine parser did use * as a deep search wildcard which is not according to the behavior sphinx does it. As the toctree is a directive defined by sphinx we try to follow that one closely. The correct way of writing a toctree is

.. toctree::
   :glob:

   **

This will include all documents and sections in a project. starting at the level of the current page.

So the origin of the menu's not working is in the way the menu's are defined. The doctrine parser did use * as a deep search wildcard which is not according to the behavior sphinx does it. As the toctree is a directive defined by sphinx we try to follow that one closely. The correct way of writing a toctree is

```
.. toctree::
   :glob:

   **
```

This will include all documents and sections in a project. starting at the level of the current page.
@greg0ire greg0ire merged commit fc64ef7 into doctrine:staging Sep 26, 2024
3 checks passed
@greg0ire
Copy link
Member

Thanks @jaapio !

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

Successfully merging this pull request may close these issues.

3 participants