Commit graph

77 commits

Author SHA1 Message Date
Mark Banner
6c0313d65c Bug 1881702 - Remove references to ESLint rule valid-jsdoc which was removed in v9. r=frontend-codestyle-reviewers,extension-reviewers,search-reviewers,omc-reviewers,android-reviewers,webcompat-reviewers,willdurand,mossop,daleharvey,twisniewski,nalexander,emcminn
Differential Revision: https://phabricator.services.mozilla.com/D251249
2025-05-29 08:30:20 +00:00
Gijs Kruitbosch
6866b9afdc Bug 1951773 - add some documentation for callModulesFromCategory, r=mconley,frontend-codestyle-reviewers,Standard8
Differential Revision: https://phabricator.services.mozilla.com/D244049
2025-04-02 18:41:13 +00:00
Julien Wajsberg
6221a919d2 Bug 1957405 - Enable markdown extensions for firefox-source-docs generation r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D243675
2025-04-01 18:02:10 +00:00
Beth Rennie
2ae4cc82d3 Bug 1942694 - Remove toolkit/components/featuregates r=settings-reviewers,firefox-desktop-core-reviewers ,frontend-codestyle-reviewers,Gijs,android-reviewers,Roger
Differential Revision: https://phabricator.services.mozilla.com/D239672
2025-03-11 18:16:50 +00:00
Aristide Tossou
a73dbc1c91 Bug 1942518 - Add Wllama engine - r=tarek,perftest-reviewers,afinder
Differential Revision: https://phabricator.services.mozilla.com/D234800
2025-03-06 22:54:36 +00:00
Mike Conley
0b2d61a5b4 Bug 1917913 - Make CustomizableUI.sys.mjs pass the valid-jsdoc ESLint rule and add initial source documentation. r=sfoster
Differential Revision: https://phabricator.services.mozilla.com/D222679
2025-01-16 21:14:21 +00:00
Sylvestre Ledru
27548816e5 Bug 1933136 - Sphinx: Force English as locale when building it r=firefox-source-docs-reviewers,ahal DONTBUILD
Some sphinx warnings might be translated and not catched by our ignore list.

Differential Revision: https://phabricator.services.mozilla.com/D230079
2024-12-06 10:13:38 +00:00
Sylvestre Ledru
69bf7fb6f3 Bug 1933136 - Sphinx: fix a sphinx get_html_theme_path warning r=firefox-source-docs-reviewers,ahal DONTBUILD
Was showing:
WARNING: Calling get_html_theme_path is deprecated. If you are calling it to define html_theme_path, you are safe to remove that code.

Differential Revision: https://phabricator.services.mozilla.com/D230078
2024-12-06 10:13:38 +00:00
Ben Dean-Kawamura
2b0abf3bad Bug 1927566 - UniFFI JS API references, r=bgruber,supply-chain-reviewers
Extended the bindings generator to generate jsdoc comments and myst
files that reference them.

Differential Revision: https://phabricator.services.mozilla.com/D228473
2024-11-12 22:14:49 +00:00
Gijs Kruitbosch
64c3f31a1f Bug 1913427 - add documentation for XPCOMUtils into firefox-source-docs, r=xpcom-reviewers,frontend-codestyle-reviewers,nika,Standard8
Differential Revision: https://phabricator.services.mozilla.com/D219320
2024-08-20 13:29:56 +00:00
Mike Conley
26bf957cd0 Bug 1893269 - Build out basic infrastructure for backup management UI. r=backup-reviewers,settings-reviewers,firefox-desktop-core-reviewers ,Gijs,fluent-reviewers,kpatenio
Differential Revision: https://phabricator.services.mozilla.com/D209161
2024-05-09 21:34:35 +00:00
Tarek Ziadé
4613397eba Bug 1890947 - Document pipelines using JSDoc r=gregtatum a=reland CLOSED TREE
Differential Revision: https://phabricator.services.mozilla.com/D208469
2024-04-25 06:30:38 +00:00
Aron Cseh
c68e277f64 Backed out changeset 7c15eacd7f68 (bug 1890947) for causing doc generate failure CLOSED TREE 2024-04-25 10:18:38 +03:00
Tarek Ziadé
0691da7f28 Bug 1890947 - Document pipelines using JSDoc r=gregtatum
Differential Revision: https://phabricator.services.mozilla.com/D208469
2024-04-25 06:30:38 +00:00
Logan Rosen
568a9b76b6 Bug 1854149 - upgrade to Sphinx 7.1.2 r=sylvestre,firefox-source-docs-reviewers DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D189725
2024-03-21 18:24:18 +00:00
Mike Conley
316cb226b4 Bug 1885366 - Add BackupResource to the backups source docs. r=backup-reviewers,kpatenio
Differential Revision: https://phabricator.services.mozilla.com/D204824
2024-03-18 17:54:19 +00:00
Mike Conley
6fe1bb3a63 Bug 1882171 - Stub out the beginnings of the BackupService. r=mossop,kpatenio,fchasen
This creates a new BackupService component that lives under browser/components/backup.
It doesn't do much yet, except allow itself to be instantiated (which currently occurs
using the idle scheduler in BrowserGlue) - but it does set us up to have docs, SphinxJS
exporting for JSDoc, linting, etc.

Differential Revision: https://phabricator.services.mozilla.com/D202753
2024-02-28 14:23:56 +00:00
Logan Rosen
a18b378958 Bug 1849084 - fix moznetwork doc generation r=firefox-source-docs-reviewers,sylvestre DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D186417
2023-08-21 10:52:36 +00:00
Sylvestre Ledru
b88e1fd8cf Bug 1825918 - doc: Do not generate the nss legacy doc r=nss-reviewers,bbeurdouche DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D174350
2023-04-25 11:07:07 +00:00
mcheang
f8066a5935 Bug 1771821 - Automatically generate API docs for SearchService using sphinx-js. r=Standard8
Differential Revision: https://phabricator.services.mozilla.com/D174830
2023-04-12 14:06:07 +00:00
ogiorgis
714b69a234 Bug 1824659 - replace sphinx panel by sphinx design r=firefox-source-docs-reviewers,perftest-reviewers,sylvestre,sparky
Differential Revision: https://phabricator.services.mozilla.com/D173680
2023-03-30 08:01:21 +00:00
Mark Banner
36ab6611df Bug 1824173 - Enable ESLint configuration valid-jsdocs across the tree, disabling for currently failing locations. r=mossop,webcompat-reviewers,extension-reviewers,credential-management-reviewers,denschub,dimi,robwu
Depends on D173450

Differential Revision: https://phabricator.services.mozilla.com/D173451
2023-03-24 19:35:25 +00:00
Ben Hearsum
7f7cfea8b0 Bug 1822165: Bump sphinxcontrib-mermaid to latest version r=releng-reviewers,gbrown
This allows us to use more modern mermaid syntax and features. I know we pinned this to an old version quite awhile ago (https://bugzilla.mozilla.org/show_bug.cgi?id=1693140), but it appears that those issues have since been fixed. At the very least, diagrams appear to have no issues rendering.

Differential Revision: https://phabricator.services.mozilla.com/D172563
2023-03-14 20:15:05 +00:00
ogiorgis
f09ce3a8dd Bug 1749473 - fix some sphinx autodoc import warnings r=firefox-source-docs-reviewers,ahal DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D168048
2023-02-07 15:32:24 +00:00
ogiorgis
c4c34a5c37 Bug 1765365 - Use sphinx search on local builds r=firefox-source-docs-reviewers,ahal
Google search cannot be used anywhere other than https://firefox-source-docs.mozilla.org

Differential Revision: https://phabricator.services.mozilla.com/D167669
2023-01-26 14:21:06 +00:00
Marco Castelluccio
f69e697461 Bug 1801836 - Remove no longer necessary 'from __future__' imports. r=linter-reviewers,glandium,webdriver-reviewers,perftest-reviewers,geckoview-reviewers,jld,ahal,owlish,afinder DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D165395
2022-12-23 22:45:46 +00:00
Mike Conley
6176149849 Bug 1802961 - Generate documentation for the new migration wizard reusable component. r=kpatenio
Differential Revision: https://phabricator.services.mozilla.com/D163390
2022-12-06 17:50:40 +00:00
Mike Conley
bd8b0c9e3b Bug 1802961 - Generate documentation for the browser/components/migration component. r=kpatenio
Differential Revision: https://phabricator.services.mozilla.com/D163258
2022-12-06 17:50:40 +00:00
Butkovits Atila
be54bd233f Backed out 7 changesets (bug 1802358, bug 1801314, bug 1802961) for causing documentation failures.
Backed out changeset bb0f5e137128 (bug 1802961)
Backed out changeset 4c2a66bfe913 (bug 1802961)
Backed out changeset baaa090cada1 (bug 1802961)
Backed out changeset d98ee38a13bb (bug 1802961)
Backed out changeset 618dcf6d8284 (bug 1802961)
Backed out changeset 59d98ca9fd51 (bug 1802358)
Backed out changeset bce1ea9149bd (bug 1801314)
2022-12-06 18:21:11 +02:00
Mike Conley
d66d780a72 Bug 1802961 - Generate documentation for the new migration wizard reusable component. r=kpatenio
Differential Revision: https://phabricator.services.mozilla.com/D163390
2022-12-06 14:46:43 +00:00
Mike Conley
0514706a2f Bug 1802961 - Generate documentation for the browser/components/migration component. r=kpatenio
Differential Revision: https://phabricator.services.mozilla.com/D163258
2022-12-06 14:46:43 +00:00
Mark Banner
24f6e8a8ca Bug 1799314 - Convert most of the JSM modules in testing/ to ES modules. r=ahal
Differential Revision: https://phabricator.services.mozilla.com/D161431
2022-11-17 12:00:25 +00:00
Gijs Kruitbosch
22d9ccf31a Bug 1763236 - Add class documentation for fundamental building block modules of our test infrastructure, r=sclements,mossop
This is not perfect, but I figured getting most of this stood up will make it easier for
other folks to improve, and is a lot better than expecting people to figure most of this
out themselves. Some known issues:

- alphabetical method ordering isn't necessarily what we want here. I haven't invested
  heavily in improving this. I think this can be a follow-up.
- no markdown or HTML support in sphinx-js so the formatting is... not good sometimes.
- types somehow get a bonus `()` chucked after them (so are listed as e.g. `String()`
  rather than just `String`). Unclear what is causing this; it's happening in other
  extant documentation, too, so I expect is a sphinx-js issue.

Differential Revision: https://phabricator.services.mozilla.com/D161650
2022-11-11 15:56:31 +00:00
Katherine Patenio
c4f6478c5d Bug 1749795 - create documentation for adding and testing site-specific wrappers. r=mhowell
Differential Revision: https://phabricator.services.mozilla.com/D142011
2022-04-22 20:46:11 +00:00
Sylvestre Ledru
e81f92e477 Bug 1730515 - FX doc: Use google search instead of sphinx search r=firefox-source-docs-reviewers,ahal DONTBUILD
sphinx search is pretty bad...

Differential Revision: https://phabricator.services.mozilla.com/D128022
2022-03-29 15:19:47 +00:00
Drew Willcoxon
88d0fc3d57 Bug 1757220 - Automatically generate API docs for a few urlbar classes using sphinx-js. r=mcheang
This does the following:

* Add the urlbar root directory to the list of sphinx-js directories
* Add three new rst files for the automatically generated API docs for
  UrlbarController, UrlbarInput, and UrlbarView
* Add a new top-level section to the urlbar's index.rst for these three docs
* Tweak two JSDocs in UrlbarSearchOneOffs so that sphinx-js doesn't complain

This should be a good starting place for integrating automatically generated API
docs into the urlbar docs, and we can iterate on it from here.

Differential Revision: https://phabricator.services.mozilla.com/D139780
2022-03-11 17:51:18 +00:00
Csoregi Natalia
3bbe5b075b Backed out changeset e665e278f4ac (bug 1730515) for causing issues on search functionality. a=backout 2022-03-04 20:04:18 +02:00
Sylvestre Ledru
20c1a08cd9 Bug 1730515 - FX doc: Use google search instead of sphinx search r=firefox-source-docs-reviewers,ahal DONTBUILD
sphinx search is pretty bad...

Differential Revision: https://phabricator.services.mozilla.com/D128022
2022-03-03 08:25:29 +00:00
Anastasios Bithas
ea71af5809 Bug 1650197 - Add an extension to autolink bug xxxxxxx strings in docs to bugzilla hyperlinks r=sylvestre DONTBUILD
An extension is created that uses SphinxTransform to convert bug xxxxxxx strings that exist in docs to reference links that redirect to the appropriate bug in bugzilla

Differential Revision: https://phabricator.services.mozilla.com/D137385
2022-01-31 15:12:40 +00:00
championshuttler
1878ff8955 Bug 1746839 - Rename the basename in firefox source docs.r=firefox-source-docs-reviewers,sylvestre DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D134270
2021-12-20 10:20:23 +00:00
championshuttler
a3dd4bd705 Bug 1746782 - Support myst parser and remove recommanmark.r=firefox-source-docs-reviewers,sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D134242
2021-12-20 09:45:44 +00:00
Sylvestre Ledru
dedafe8aea Bug 1740890 - doc: Silent a recommonmark warning r=firefox-source-docs-reviewers,championshuttler DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D131047
2021-11-16 07:59:48 +00:00
Myeongjun Go
a2e121e262 Bug 1674220 - [perfdocs] Enumerate Talos tests using PerfDocs r=sparky,perftest-reviewers
Differential Revision: https://phabricator.services.mozilla.com/D128037
2021-11-02 19:11:06 +00:00
Sylvestre Ledru
f731231c7e Bug 1720922 - Use right sphinx function (the old func has been removed) r=firefox-build-system-reviewers,mhentges
Differential Revision: https://phabricator.services.mozilla.com/D120087
2021-07-16 17:38:43 +00:00
Mitchell Hentges
4cce0c5e12 Bug 1714641: Remove usages of vendored "futures" library r=ahal
`concurrent.futures` functionality has been part of Python since
Python 3.2.

Differential Revision: https://phabricator.services.mozilla.com/D117068
2021-06-09 15:48:54 +00:00
Henrik Skupin
2c6099421a Bug 1693993 - [marionette] Move Marionette server code to /remote/marionette. r=remote-protocol-reviewers,marionette-reviewers,jdescottes,webdriver-reviewers
Differential Revision: https://phabricator.services.mozilla.com/D106311
2021-05-31 17:36:06 +00:00
Alexandru Michis
d30bd50d0f Backed out changeset 37f2f9ef6ef8 (bug 1693993) for containing unreviewed changes.
CLOSED TREE
2021-05-31 15:55:11 +03:00
Henrik Skupin
55d4518049 Bug 1693993 - [marionette] Move Marionette server code to /remote/marionette. r=remote-protocol-reviewers,marionette-reviewers,jdescottes,webdriver-reviewers
Differential Revision: https://phabricator.services.mozilla.com/D106311
2021-05-31 08:56:32 +00:00
Chris H-C
f666fb3dc9 Bug 1705403 - Replace FOG's Glean autodocs with link to Glean Dictionary r=janerik DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D114631
2021-05-10 13:33:09 +00:00
Myeongjun Go
a4c2f8da8d Bug 1698567 - [perfdocs] Provide a way to link directly to individual Raptor tests r=sparky,perftest-reviewers,firefox-source-docs-reviewers,ahal
Differential Revision: https://phabricator.services.mozilla.com/D110779
2021-04-27 18:19:03 +00:00