Skip to content

Fix default role #337

@xmo-odoo

Description

@xmo-odoo

In rST/sphinx, the single backtick is an alias for the "default role" which defaults (haha) to implicit / title references. This is not very useful, and we never implemented it in our theming which often generates warnings.

It's unclear what to define the default role to though:

  • we could use "inline literal" (rST's double backtick) as that matches Markdown
  • we could use sphinx's any as it exists pretty much for that reason, note that we may still need some sort of fallback if writers use single backticks for stuff which is not a ref' to anything
  • we could raise an error when it's used, though that assumes people who write doc at least build it let alone look at it (which is clearly not the case), or we add some sort of CI to the repo

/cc @mart-e

Metadata

Metadata

Assignees

Labels

technical improvementTechnically improve the documentation site

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions