Closed Bug 1674152 Opened 7 months ago Closed 2 months ago

Make Picture-in-Picture code emit interface documentation via SphinxJS

Categories

(Toolkit :: Video/Audio Controls, task, P3)

Product:
Toolkit
Component:
Video/Audio Controls
Type:
task

Tracking

()

Status:
RESOLVED FIXED
Milestone:
89 Branch
Tracking Flags:
Tracking Status
firefox89 --- fixed

People

(Reporter: mconley, Assigned: frostwyrm98)

References

(Blocks 2 open bugs)

Details

Attachments

(1 file, 1 obsolete file)

Bug 1674152 - Building documentation for Picture-in-Picture using SphinxJS
48 bytes, text/x-phabricator-request
Details | Review

A number of the functions in the Picture-in-Picture code is documented in a pseudo-JSDoc style.

If we can follow the JSDoc dialect in https://pypi.org/project/sphinx-js/, then we can add "../toolkit/components/pictureinpicture" to this list: https://searchfox.org/mozilla-central/rev/a147181ece866c1ecd176ac49f112785f960aac0/docs/conf.py#55-63

and then it'd be converted at build-time to nice documents like this:

https://firefox-source-docs.mozilla.org/toolkit/mozapps/extensions/addon-manager/AddonManager.html

Severity: -- → N/A
Priority: -- → P3
Assignee: nobody → rajendran.manish
Blocks: 1685549
No longer blocks: 1662870
Assignee: rajendran.manish → frostwyrm98
Status: NEW → ASSIGNED
Attachment #9202964 - Attachment description: Bug 1674152 - Building documentation for Picture-in-Picture using SphinxJS. Changed formatting to support parsing, adding config files to target for parsing by SphinxJS via mach docs command. → Bug 1674152 - Building documentation for Picture-in-Picture using SphinxJS
Attachment #9202964 - Attachment description: Bug 1674152 - Building documentation for Picture-in-Picture using SphinxJS → Bug 1674152 - Building documentation for Picture-in-Picture using SphinxJS. Changed formatting to support parsing, adding config files to target for parsing by SphinxJS via mach docs command.
Attachment #9202964 - Attachment description: Bug 1674152 - Building documentation for Picture-in-Picture using SphinxJS. Changed formatting to support parsing, adding config files to target for parsing by SphinxJS via mach docs command. → Bug 1674152 - Building documentation for Picture-in-Picture using SphinxJS
Attachment #9204310 - Attachment is obsolete: true

There's a r+ patch which didn't land and no activity in this bug for 2 weeks.
:frostwyrm98, could you have a look please?
For more information, please visit auto_nag documentation.

Flags: needinfo?(mtigley)
Flags: needinfo?(frostwyrm98)

Need to fix a linting error in the current revision, and then we'll be ready to land the patch.

Flags: needinfo?(mtigley)

(In reply to Micah Tigley [:mtigley] from comment #4)

Need to fix a linting error in the current revision, and then we'll be ready to land the patch.

Working on fixing it now!

Flags: needinfo?(frostwyrm98)
Pushed by mtigley@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/611380247e15
Building documentation for Picture-in-Picture using SphinxJS r=mtigley

https://hg.mozilla.org/mozilla-central/rev/611380247e15

Status: ASSIGNED → RESOLVED
Closed: 2 months ago
status-firefox89: --- → fixed
Resolution: --- → FIXED
Target Milestone: --- → 89 Branch
You need to log in before you can comment on or make changes to this bug.