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

Make docs valid according to guides 0.3.3 #11252

Merged
merged 3 commits into from
Feb 12, 2024

Conversation

greg0ire
Copy link
Member

@greg0ire greg0ire commented Feb 12, 2024

Cc @linawolf @jaapio

Here are the warnings that are left:

[2024-02-12T22:38:40.171860+00:00] app.WARNING: No template found for rendering directive "sectionauthor". Expected template "body/directive/sectionauthor.html.twig" [] []
[2024-02-12T22:38:40.178561+00:00] app.WARNING: No template found for rendering directive "sectionauthor". Expected template "body/directive/sectionauthor.html.twig" [] []
[2024-02-12T22:38:40.181593+00:00] app.WARNING: No template found for rendering directive "sectionauthor". Expected template "body/directive/sectionauthor.html.twig" [] []
[2024-02-12T22:38:40.183047+00:00] app.WARNING: No template found for rendering directive "sectionauthor". Expected template "body/directive/sectionauthor.html.twig" [] []
[2024-02-12T22:38:40.184515+00:00] app.WARNING: No template found for rendering directive "sectionauthor". Expected template "body/directive/sectionauthor.html.twig" [] []
[2024-02-12T22:38:40.187207+00:00] app.WARNING: No template found for rendering directive "sectionauthor". Expected template "body/directive/sectionauthor.html.twig" [] []
[2024-02-12T22:38:40.187977+00:00] app.WARNING: No template found for rendering directive "sectionauthor". Expected template "body/directive/sectionauthor.html.twig" [] []
[2024-02-12T22:38:40.193160+00:00] app.WARNING: No template found for rendering directive "sectionauthor". Expected template "body/directive/sectionauthor.html.twig" [] []
[2024-02-12T22:38:40.384154+00:00] app.WARNING: No template found for rendering directive "toc". Expected template "body/directive/toc.html.twig" [] []
[2024-02-12T22:38:40.384251+00:00] app.WARNING: No template found for rendering directive "tocheader". Expected template "body/directive/tocheader.html.twig" [] []
[2024-02-12T22:38:40.388428+00:00] app.WARNING: No template found for rendering directive "toc". Expected template "body/directive/toc.html.twig" [] []
[2024-02-12T22:38:40.388493+00:00] app.WARNING: No template found for rendering directive "tocheader". Expected template "body/directive/tocheader.html.twig" [] []
[2024-02-12T22:38:40.411127+00:00] app.WARNING: No template found for rendering directive "toc". Expected template "body/directive/toc.html.twig" [] []
[2024-02-12T22:38:40.411187+00:00] app.WARNING: No template found for rendering directive "tocheader". Expected template "body/directive/tocheader.html.twig" [] []

I suppose the next step could be to create some kind of doctrine extension for the guides that will contain the templates mentioned above, based on

?

There even is a note in the official docs about it.
This silences a warning about it having no title. It also means we no
longer have to work around this in the CI
@derrabus derrabus merged commit 1d218ba into doctrine:2.18.x Feb 12, 2024
1 check passed
@greg0ire greg0ire deleted the more-valid-docs branch February 12, 2024 22:47
@jaapio
Copy link

jaapio commented Feb 13, 2024

I think you can replace the toc node with a container directive. As it is nothing more than just a wrapper?

For the others you would indeed need an extension that adds the templates and directives to your documentation builder.

If needed I can help you with that, even if it was just missing documentation on our side.

@linawolf
Copy link

@greg0ire @jaapio as the sectionauthor seems to be an official sphinx directive we could also add it directly to the guides: https://certik.github.io/sphinx/markup/desc.html

@jaapio
Copy link

jaapio commented Feb 13, 2024

Yes please 🙏

derrabus added a commit to derrabus/orm that referenced this pull request Feb 21, 2024
* 2.19.x:
  Fix Static Analysis folder reference (doctrine#11281)
  docs: recommend safer way to disable logging (doctrine#11269)
  Remove unused baseline entries
  Treat '0' as a legitimate trim char
  Add type field mapper documentation to the sidebar
  Mark document as orphan
  Use correction sectionauthor syntax
  Make docs valid according to guides 0.3.3 (doctrine#11252)
derrabus added a commit to derrabus/orm that referenced this pull request Feb 21, 2024
* 3.1.x:
  Fix Static Analysis folder reference (doctrine#11281)
  Remove broken assertion from DateAddFunction and DateSubFunction (doctrine#11243)
  Account for inversedBy being a non-falsy-string or null
  Improve static analysis on AttachEntityListenersListener
  docs: recommend safer way to disable logging (doctrine#11269)
  Remove unused baseline entries
  Treat '0' as a legitimate trim char
  Add type field mapper documentation to the sidebar
  Mark document as orphan
  Use correction sectionauthor syntax
  Remove unused trait
  [Documentation] Adding link to Postgres upgrade article (doctrine#11257)
  Validate more variadic parameters (doctrine#11261)
  Throw if a variadic parameter contains unexpected named arguments (doctrine#11260)
  Make docs valid according to guides 0.3.3 (doctrine#11252)
  fix: support array-type arg in QB variadic calls (doctrine#11242)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants