BlueBrain / BlueBrain/Atlas-Download-Tools
Decide for monospaced text syntax in RST files
- Dominant language
- Python
- Stars
- 17
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
There are different ways to get monospaced font in docs:
- `` :code:`stuff` ``
- `` `stuff` ``
- ``` ``stuff`` ```
According to the [some docs](https://docutils.sourceforge.io/docs/user/rst/quickref.html#inline-markup)
- `` `stuff` `` = interpreted text
- ``` ``stuff`` ``` = inline literal
Usually when I want monospaced text in `rst` I go for ``` ``stuff`` ```. Is `` :code:`stuff` `` going to add some additional functionality/highlighting?
Is `` :code:`stuff` `` part of the `rst` syntax or is it specifi to Sphinx?
_Originally posted by @Stannislav in https://github.com/BlueBrain/Atlas-Download-Tools/pull/56#discussion_r691301335_
Contributor guide
Research direction
Start by reviewing the repository's RST documentation and the cited Docutils inline-markup reference. Done means the project has a documented, consistent choice between interpreted text, inline literals, and Sphinx code roles, including whether Sphinx-specific behavior is intended.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100