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

Fix incorrect formatting in docs #930

Merged
merged 6 commits into from Dec 6, 2021

Commits on Dec 2, 2021

  1. Correct formatting in documentation

    RST uses double backticks to indicate verbati formatting but there were
    many places that used only a single backtick, which is correct for Markdown.
    samdoran committed Dec 2, 2021
    Configuration menu
    Copy the full SHA
    cfe98f6 View commit details
    Browse the repository at this point in the history
  2. Catch incorrect formatting in docs build

    Setting the default_role to 'any' is a bit indirect, but it has the effect of
    catching words surround only by single backticks.
    
    Also enable nitpicky mode which will catch bad references.
    samdoran committed Dec 2, 2021
    Configuration menu
    Copy the full SHA
    460255f View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    11e52f6 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    ee00476 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    6c7783c View commit details
    Browse the repository at this point in the history

Commits on Dec 6, 2021

  1. Configuration menu
    Copy the full SHA
    d75c495 View commit details
    Browse the repository at this point in the history