1458882 - Link to rendered documentation at firefox-source-docs.mozilla.org

Status: ASSIGNED

(Webtools :: Searchfox, enhancement)

Description

[Kartikaya Gupta (email:[e-mail])]

e.g. the page at https://searchfox.org/mozilla-central/source/build/docs/defining-binaries.rst should have a link to the fancy schmancy rendered view at https://firefox-source-docs.mozilla.org/build/buildsystem/defining-binaries.html

Comment 1

[Kartikaya Gupta (email:[e-mail])]

https://github.com/mozsearch/mozsearch/commit/18355d19721f3959e4f42a59960a2bd41fe7c4c4 is a previous change that points to the relevant code that will need modification. We can add a config property that points to the rendered documentation root and then use the path of .rst files to figure out the path of the rendered html file. I don't think firefox-source-docs.m.o keeps old versions around, so maybe point to github's rendered view of .rst and .md files for older revisions? Or just skip that entirely.

Comment 3

[Kartikaya Gupta (email:[e-mail])]

(In reply to Kartikaya Gupta (email:[e-mail]) from comment #1)

We can add a config property
that points to the rendered documentation root and then use the path of .rst
files to figure out the path of the rendered html file.

Not that easy, unfortunately. The moz.build files have SPHINX_TREES entries that provide the mappings from in-tree path to firefox-source-docs.m.o URL path. We'll either need to parse those files or produce a taskcluster artifact with the mapping.

Comment 4

[Andrew Sutherland [:asuth] (he/him)]

Relevant links:

• https://searchfox.org/mozilla-central/source/taskcluster/ci/source-test/doc.yml is the taskcluster job that produces a .tar.gz of the documents via mach doc
• https://searchfox.org/mozilla-central/source/tools/moztreedocs/mach_commands.py is the mach command
  • https://searchfox.org/mozilla-central/rev/80a0f3af240b6fefdfbff71a881bd96637f9a19b/tools/moztreedocs/__init__.py#43-75 is the read_build_config logic that extracts the SPHINX_TREES variables. It uses a BuildReader which has generated documentation that can currently be found here: https://firefox-source-docs.mozilla.org/python/mozbuild.frontend.html#mozbuild.frontend.reader.BuildReader.
  • Interestingly, it seems like the use of find_variables_from_ast may currently only be used by the doc builder and the mechanism that seems to categorize the tests into a11y/browser-chrome/chrome/mochitest/xpcshell.

Comment 5

[Andrew Halberstadt [:ahal]]

Attachment: Bug 1458882 - [moztreedocs] Add flag to dump sphinx trees to a file, r?#firefox-source-docs-reviewers!

This will enable tools like searchfox to map source files in the
tree to their rendered URLs.

Comment 6

[Andrew Halberstadt [:ahal]]

I'm not actively working on this, though the attached patch should at least make this possible.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/6b854ed6f7ef
[moztreedocs] Add flag to dump sphinx trees to a file, r=firefox-source-docs-reviewers,sylvestre

Comment 8

[Serban Stanca [:SerbanS]]

https://hg.mozilla.org/mozilla-central/rev/6b854ed6f7ef