Merge staging into master #618
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I introduced an interface to be able to switch between the different implementations. The first setup of guides is done at the required locations and allows us to render the documentation. However this doesn't work yet without issues. More might be needed consider this work in progress.
Use guides to render rst pages.
As toctree does modify the structure of the docs, which results in infinitif loops when items refer to eachother, we switched to menu.
To allow full usage of the configuration move the theme configuration to a compiler pass that will set the value.
Introduce phpdoc guides builder
Small tweaks in new rendering
Apply the correct template for section authors. Add an extra fix in the migration from old doc styles to correct the display of author names.
We do want to include every document in the menu when we do a fallback to the default menu. `/*` does match all files are root level, while we wanted to match everything `*`.
The upgrade of guides contains the fix required to make the menu render the section titles of each page.
Fix section author markup
Render menu titles
Full wildcard match on default menu
The logger introduced before was very usefull in the setup process but by now, it should be replaced by something more mature to ensure the logs to not end up in the final output.
Replace logger with monolog
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.
Improve menu generation
This was referenced Sep 27, 2024
SenseException
approved these changes
Sep 27, 2024
|
Build goes weeeeeeee. |
|
Thanks @SenseException and @greg0ire for your reviews and testing work last week. I love open source and doctrine. Let me know if you need any help with the docs in the future. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think the new docs are good enough if not better 🙂