[Doc] Fix some minor markup errors in manual #20112
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Fix header level for noalias pragma section. * Fix code snippet outside of code block that raised an error with `rst2html`. * Fix broken 'Convertible relation' links that were raising warnings.
|
It's worth noting that all automatic links to subsections (like We shall to convert them to Markdown style links anyway. Markdown spec allows only links with the explicit target, but fortunately there is the implicit_header_references extension from Pandoc Markdown. To summarize: Type relations
==============
Convertible relation
--------------------
Old RST ways of referencing:
- manual `Convertible relation <#type-relations-convertible-relation>`_
- automatic, buggy in devel `Convertible relation`_
New Markdown ways:
- manual [Convertible relation](#type-relations-convertible-relation)
- automatic, not yet supported: [Convertible relation]() |
|
@a-mr I thought there was some automatic mechanism and I tried removing the explicit anchor in the first link, but it wasn't working. Good to know about the changes. Thank you |
Varriount
approved these changes
Aug 1, 2022
|
Actually I re-checked links to sub-headers in 1.6 and 1.0 and it did not work. |
a-mr
added a commit
to a-mr/Nim
that referenced
this pull request
Aug 27, 2022
It was observed (in nim-lang#20112) that links to 2nd- (and subsequent) -level headings fail if TOC is present, e.g.: ```nim .. contents:: Type relations ============== Convertible relation -------------------- Ref. `Convertible relation`_ ``` The problem here is that links are resolved in `rst.nim` but later `rstgen.nim` fixes ("fixes") anchors to make them unique so that TOC always works (if e.g. there was another sub-section like "Convertible relation"). The solution implemented in this PR is to move that fix-up of anchors into `rst.nim`, so that link resolution could know final anchors. The bug seems to be added in nim-lang#2332 in 2015, that is it is present in Nim 1.0.
Varriount
pushed a commit
that referenced
this pull request
Aug 27, 2022
Fix links to subheader when TOC is present It was observed (in #20112) that links to 2nd- (and subsequent) -level headings fail if TOC is present, e.g.: ```nim .. contents:: Type relations ============== Convertible relation -------------------- Ref. `Convertible relation`_ ``` The problem here is that links are resolved in `rst.nim` but later `rstgen.nim` fixes ("fixes") anchors to make them unique so that TOC always works (if e.g. there was another sub-section like "Convertible relation"). The solution implemented in this PR is to move that fix-up of anchors into `rst.nim`, so that link resolution could know final anchors. The bug seems to be added in #2332 in 2015, that is it is present in Nim 1.0.
capocasa
pushed a commit
to capocasa/Nim
that referenced
this pull request
Mar 31, 2023
* Fix header level for noalias pragma section. * Fix code snippet outside of code block that raised an error with `rst2html`. * Fix broken 'Convertible relation' links that were raising warnings. Co-authored-by: quantimnot <[email protected]>
capocasa
pushed a commit
to capocasa/Nim
that referenced
this pull request
Mar 31, 2023
Fix links to subheader when TOC is present It was observed (in nim-lang#20112) that links to 2nd- (and subsequent) -level headings fail if TOC is present, e.g.: ```nim .. contents:: Type relations ============== Convertible relation -------------------- Ref. `Convertible relation`_ ``` The problem here is that links are resolved in `rst.nim` but later `rstgen.nim` fixes ("fixes") anchors to make them unique so that TOC always works (if e.g. there was another sub-section like "Convertible relation"). The solution implemented in this PR is to move that fix-up of anchors into `rst.nim`, so that link resolution could know final anchors. The bug seems to be added in nim-lang#2332 in 2015, that is it is present in Nim 1.0.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
rst2html.