Closed Bug 1621950 Opened 4 years ago Closed 1 year ago

Linking from .md files to .rst files is a suboptimal experience

Categories

(Developer Infrastructure :: Source Documentation, defect)

defect

Tracking

(firefox113 fixed)

RESOLVED FIXED
Tracking Status
firefox113 --- fixed

People

(Reporter: chutten, Assigned: ogiorgis)

References

(Blocks 1 open bug)

Details

Attachments

(1 file)

To reference from md files other documentation written in markdown, you can use the form /path/to/doc_file.md and someone in the recommonmark/sphinx stack will rewrite that for you to an appropriate absolute url ending in .html.

To reference from md files other documentation written in rst, things are not so rosy. I've tried "Pagenmame" "../sphinx/path/to/Pagename" "doc_file_name.rst".... the only one that seems to work is ../resulting/relative/http/path/to/doc_file_name.html.

And that one unfortunately springs a warning WARNING: None:any reference target not found:

On changing

[Quick Start Guide](https://firefox-source-docs.mozilla.org/mobile/android/geckoview/consumer/docs/geckoview-quick-start.html)

to

[Quick Start Guide](./consumer/docs/geckoview-quick-start.html)

here
results link not to be created.

While the same works if used in a non bullet point format.

That might be a separate issue with how recommonmark uses bullet-point lists to generate tables of contents: https://recommonmark.readthedocs.io/en/latest/auto_structify.html#auto-toc-tree

Because this bug's Severity has not been changed from the default since it was filed, and it's Priority is -- (Backlog,) indicating it has has not been previously triaged, the bug's Severity is being updated to -- (default, untriaged.)

Because this bug's Severity has not been changed from the default since it was filed, and it's Priority is -- (Backlog,) indicating it has has not been previously triaged, the bug's Severity is being updated to -- (default, untriaged.)

Because this bug's Severity has not been changed from the default since it was filed, and it's Priority is -- (Backlog,) indicating it has has not been previously triaged, the bug's Severity is being updated to -- (default, untriaged.)

Severity: normal → S3

The severity of these bugs was changed, mistakenly, from normal to S3.

Because these bugs have a priority of --, indicating that they have not been previously triaged, these bugs should be changed to Severity of --.

Severity: S3 → --
Product: Firefox Build System → Developer Infrastructure
Assignee: nobody → ogiorgis
Status: NEW → ASSIGNED
Pushed by sledru@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/8c35fddc4405
fix some myst ref warnings r=firefox-source-docs-reviewers,devtools-reviewers,sylvestre
Status: ASSIGNED → RESOLVED
Closed: 1 year ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: