1666257 - fx doc: Limit the depth of autosection

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Documentation, task)

Description

[Sylvestre Ledru [:Sylvestre]]

Only run autosection for the page title.
Otherwise, we have a huge number of duplicate links.
For example, the page https://firefox-source-docs.mozilla.org/code-quality/lint/
is called "Linting"
just like https://firefox-source-docs.mozilla.org/remote/CodeStyle.html

And creating a :ref:Linting point to the latter.

We have also a huge number of dup label as they are following the same template:
https://firefox-source-docs.mozilla.org/code-quality/lint/linters/codespell.html
https://firefox-source-docs.mozilla.org/code-quality/lint/linters/cpp-virtual-final.html
...

Comment 1

[Sylvestre Ledru [:Sylvestre]]

It also decreases the number of warnings:

build a réussi, 637 warnings.

was:

build a réussi, 1463 warnings.

It will probably create some broken links but it should be easy to fix (just need to add some labels by hands)

Comment 2

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1666257 - fx doc: Limit the depth of autosection r?#firefox-source-docs-reviewers

Only run autosection for the page title.
Otherwise, we have a huge number of duplicate links.
For example, the page https://firefox-source-docs.mozilla.org/code-quality/lint/
is called "Linting"
just like https://firefox-source-docs.mozilla.org/remote/CodeStyle.html

And creating a :ref:Linting point to the latter.

We have also a huge number of dup label as they are following the same template:
https://firefox-source-docs.mozilla.org/code-quality/lint/linters/codespell.html
https://firefox-source-docs.mozilla.org/code-quality/lint/linters/cpp-virtual-final.html

It also decreases the number of warnings (1463 to 637)

Depends on D90855

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/3edeb4b75820
fx doc: Limit the depth of autosection r=firefox-source-docs-reviewers,championshuttler

Comment 4

[Dorel Luca [:dluca]]

https://hg.mozilla.org/mozilla-central/rev/3edeb4b75820