Syntax (RST) fix Internals of the Compiler

[saem]

'Rebuilding the Compiler' and a few other sections required syntax fixes:

• new lines before and after lists to fix rendering
• use internal reference instead of Markdown style link

[juancarlospaco]

Do not double-backtick everything, Nim supports RST and MD mixed, so is OK to have single backtick.

[saem]

OK, I'll unwind the backticks.

However, it doesn't render well for those simply viewing this on github without going through any transform.

[saem]

Updated so I no longer use double backticks, built it locally and retested the links in the generated docs -- they seem to work.

[timotheecour]

However, it doesn't render well for those simply viewing this on github without going through any transform.

I understand; note that this argument is currently moot because https://github.com/nim-lang/Nim/blob/devel/doc/manual.rst doesn't even render well already (github doesn't interpret it correctly; unlike https://github.com/nim-lang/Nim/blob/devel/doc/intern.rst), as reported in #4864 (comment); and I'd rather not have 2 separate syntaxes for docs in nim vs docs in rst.

4 solutions:

• simplest: people who care about seeing it rendered can look at https://nim-lang.github.io/Nim/manual.html, which also offers additional benefits such as search, better working links etc
• improve github linguist https://github.com/github/linguist so it works well with nim's flavor of rst (or rename rst to nimrst since it's not true rst already, but github linguist only supports "popular enough" extensions)
• my preferred approach was to move *.rst to *.nim (I showed it's 100% possible here: [CI, performance] .. code-block:: :test: snippets should combine in a single compilation & run #14313 (comment), and it offers more flexiblity, such as using macros to generated boilerplate such as tables)
• use markdown instead of rst (refs [WIP] [not ready for formal review] RST to markdown for Nim repo #9487 aimed at automating transition) but this approach has its own issues, see thread here: [RFC] module/package level pragma {.doctype: markdown|rst.} to help migrate docs from RST to Markdown  RFCs#68

using our own flavor of rst (or md) has significant advantages when it comes to using our own tools to render it (allows more features for docgen) but comes at price of it not working so well when rendered with other tools. I think it's an acceptable tradeoff.

[saem]

However, it doesn't render well for those simply viewing this on github without going through any transform.

I understand; note that this argument is currently moot because https://github.com/nim-lang/Nim/blob/devel/doc/manual.rst doesn't even render well already (github doesn't interpret it correctly; unlike https://github.com/nim-lang/Nim/blob/devel/doc/intern.rst); and I'd rather not have 2 separate syntaxes for docs in nim vs docs in rst.
...

Thanks for the insight @timotheecour.