nci / scores

scores: Metrics for the verification, evaluation and optimisation of forecasts, predictions or models.
https://scores.readthedocs.io/
Apache License 2.0
82 stars 25 forks source link

Set default_role to 'literal' to allow single backtick to render as code in docs #757

Open lucyleeow opened 5 days ago

lucyleeow commented 5 days ago

You can change the default_role in sphinx doc config to 'literal' to allow single backticks to render as code. This makes it consistent between rst and markdown.

Here is a related conversation over in scikit-learn about single vs double backtick: https://github.com/scikit-learn/scikit-learn/issues/14665

Discussed with @tennlee at the pycon au sprint.