Open Bug 1428817 Opened 7 years ago Updated 3 years ago

Automatically generate docs from Javascript files using ./mach doc

Categories

(Toolkit :: Telemetry, enhancement, P4)

Product:
Toolkit
Component:
Telemetry
Type:
enhancement

Tracking

()

Tracking Flags:
Tracking Status
firefox59 --- affected

People

(Reporter: Dexter, Unassigned)

References

(Blocks 1 open bug)

Details

We now run "sphinx_js" when generating in-tree docs using ./mach doc. This means that we can generate documentation from the source code if we use the JSDoc syntax. Adding support for this might be as easy as just adding our path to: https://searchfox.org/mozilla-central/rev/f42618c99dcb522fb674221acfbc68c2d92e7936/tools/docs/conf.py#48-50
Blocks: 1413969
Priority: -- → P4
Severity: normal → S3
You need to log in before you can comment on or make changes to this bug.