Skip to content

Change conf.py to allow single backticks for inline sphinx code#40

Merged
c-randall merged 3 commits into
mainfrom
docs/backticks
Dec 12, 2025
Merged

Change conf.py to allow single backticks for inline sphinx code#40
c-randall merged 3 commits into
mainfrom
docs/backticks

Conversation

@c-randall

Copy link
Copy Markdown
Collaborator

Description

Set default_role = 'literal' in conf.py so that single backticks can be used in docstrings and .rst files for inline code rather than requiring double backticks.

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that improves speed/readability/etc.)
  • Bug fix (non-breaking change which fixes an issue)
  • Chore (any other clean up, maintenance, etc.)

Key checklist

  • No style issues: $ nox -s linter [-- format]
  • Code is free of misspellings: $ nox -s codespell [-- write]
  • All tests pass: $ nox -s tests
  • Badges are updated: $ nox -s badges

Further checks:

  • The documentation builds: $ nox -s docs.
  • Code is commented, particularly in hard-to-understand areas.
  • Tests are added that prove fix is effective or that feature works.

@c-randall c-randall marked this pull request as ready for review December 12, 2025 17:19
@c-randall c-randall merged commit 029979d into main Dec 12, 2025
10 checks passed
@c-randall c-randall deleted the docs/backticks branch December 12, 2025 17:19
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.

1 participant