search

sonata-project / SonataAdminBundle

The missing Symfony Admin Generator
https://docs.sonata-project.org/projects/SonataAdminBundle
MIT License
2.11k stars 1.26k forks source link

[Docs] fix some minor RST syntax issues #8217

Closed javiereguiluz closed 4 days ago

javiereguiluz commented 4 days ago

Subject

Sonata docs building in symfony.com is failing because of the changes introduced in https://github.com/sonata-project/SonataAdminBundle/pull/8212/files

zyberspace commented 4 days ago

@javiereguiluz Thanks! Just for the future, where can i find the symfony docs build, so i can check this beforehand next time?

javiereguiluz commented 4 days ago

@zyberspace doc build errors are published at https://symfony.com/doc/build_errors

I was going to recommend using the nice DOCtor-RST project (https://github.com/OskarStark/doctor-rst) to lint the RST syntax, but this is already being used in this project (see https://github.com/sonata-project/SonataAdminBundle/blob/c4705be1e1a7e6d0bb04b5f406b3d38b7dc93443/.github/workflows/documentation.yaml#L51) so most issues will be caught when sending a doc PR here.