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

[Doc] Misc fixes in some doc pages #1575

Merged
merged 1 commit into from
Mar 23, 2024
Merged

[Doc] Misc fixes in some doc pages #1575

merged 1 commit into from
Mar 23, 2024

Conversation

javiereguiluz
Copy link
Contributor

Q A
Branch? 2.x
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Fixed tickets -
License MIT
Doc -

Fixes these errors shown when building the docs:

Found invalid reference "../events.rst" in file "cache-resolver/aws_s3"
Found invalid reference "Imagine\Image\ImageInterface" in file "filters/general"
Found invalid reference "sys_get_temp_dir()" in file "filters/general"

@coveralls
Copy link

Coverage Status

coverage: 82.018%. remained the same
when pulling 3b9cb5f on javiereguiluz:fix_docs
into 118d419 on liip:2.x.

Copy link
Member

@dbu dbu left a comment

Choose a reason for hiding this comment

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

thank you.

you build this doc with sphinx, right? is it built-standalone or integrated with the rest of the symfony doc? if it is stand-alone, we could add a build in the ci of the bundle to get immediate feedback when we break something.

@dbu dbu merged commit 6557446 into liip:2.x Mar 23, 2024
29 of 30 checks passed
@javiereguiluz javiereguiluz deleted the fix_docs branch March 25, 2024 12:41
@javiereguiluz
Copy link
Contributor Author

@dbu we used Sphinx in the past, but it's hard to maintain ... so we moved from Sphinx (Python) to a custom-made and 100% PHP alternative: https://github.com/symfony-tools/docs-builder

You can see it in action here: https://github.com/symfony/symfony-docs/tree/7.1/_build

This custom-made solution used packages from other communities, like Doctrine's RST parser. Other projects like TYPO3 (https://github.com/TYPO3-Documentation) also wanted a PHP-based RST parser ... so, Doctrine, TYPO3, Symfony, etc. joined forces and there's a new tool to replace the existing one.

We don't use it yet to build Symfony docs, but I hope to use it "soon".

@dbu
Copy link
Member

dbu commented Mar 25, 2024

ah, glad to hear. but we won't need to change the doc format, right?

@javiereguiluz
Copy link
Contributor Author

Correct! We still use the exact same RST syntax as before ... but now, we handle it with PHP code.

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