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 .rst document formatting #3015

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Dazza0
Copy link

@Dazza0 Dazza0 commented Mar 7, 2025

Describe the PR

This MR changes the following (listed in commit order):

  • Turn docs/contributing/code_of_conduct.rst and docs/info/contributors.rst into proper files (previously were symbolic links)
  • Fixed code formatting in .rst files
    • Ensure all references to symbols (functions/variables etc) are displayed as inline literals (wrapped with double back ticks)
      • All references to variables, macros, paths, UI options appear verbatim as inline literals (e.g., some_variable, SOME_MACRO, path/to/something, Some UI Option).
      • All references to functions are suffixed with parenthesis as inline literals (e.g., some_func())
    • Ensure that all code blocks have language specific syntax highlighting (if highlighting for that language is supported sphinx).

Additional context
If applicable, add any other context about the PR and/or screenshots here.

Dazza0 added 2 commits March 7, 2025 21:19
"code_of_conduct.rst" and "contributors.rst" both contain RST include
directives, but their file types are symoblic links. This commit turns them
into proper files.
- Added missing inline literals (double backticks) to any reference of symbol
names and macros
- Added language specifier to "code-block" directives to enable syntax
highlighting when rendered.
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