Commit Graph

68 Commits

Author SHA1 Message Date
Gijs Kruitbosch
3f1cdc7803 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
5b979dc884 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é
a197bc5cbb 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
385abeeaff Backed out changeset 7c15eacd7f68 (bug 1890947) for causing doc generate failure CLOSED TREE 2024-04-25 10:18:38 +03:00
Tarek Ziadé
eb679b87c7 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
d2dee99fd1 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
d4f9331382 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
b85dcce676 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
38f74fee59 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
71259c7e1f 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
8b0a732ac8 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
2441601cae 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
e8daad195d 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
645ad14a82 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
972042e705 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
91d5f88e98 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
ba39d286d5 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
7657f98f83 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
2e9c823cf7 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
b517540509 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
05326a07df 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
c02f79d874 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
a88d045081 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
c03503d2b3 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
4091c991e8 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
4aaf2460e6 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
029f127a5d 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
37f6039fe5 Backed out changeset e665e278f4ac (bug 1730515) for causing issues on search functionality. a=backout 2022-03-04 20:04:18 +02:00
Sylvestre Ledru
7e17c026f8 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
4a9582898f 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
91edee1f92 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
5c40b79906 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
7858572f8f 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
08e06921c7 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
3d779d186d 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
552fb9b1cb 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
36cc3dc850 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
a6aa18d96d Backed out changeset 37f2f9ef6ef8 (bug 1693993) for containing unreviewed changes.
CLOSED TREE
2021-05-31 15:55:11 +03:00
Henrik Skupin
fa5bcfaea9 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
17b8cfbc81 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
56369120cf 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
championshuttler
0fffe37fbb Bug 1693140 - Fix the mermaid rendering issue.r=ahal
sphinxcontrib-mermaid loads the mermaid library in different way which prevents mermaid library to load on production, it will work locally but not on writethedocs, so we have to hard loading the mermaid library through CDN in our tree.

Differential Revision: https://phabricator.services.mozilla.com/D111161
2021-04-09 13:26:53 +00:00
Tony Froman
e006ae203d Bug 1674152 - Building documentation for Picture-in-Picture using SphinxJS r=mtigley
Changed formatting to support parsing, adding config files to target for parsing by SphinxJS via mach docs command.

Differential Revision: https://phabricator.services.mozilla.com/D105061
2021-03-26 21:55:19 +00:00
Myeongjun Go
91f7e082ad Bug 1691739 - [perfdocs] Display each test description for raptor r=sparky,perftest-reviewers
Differential Revision: https://phabricator.services.mozilla.com/D105643
2021-03-11 15:59:15 +00:00
championshuttler
cc5f8f3cba Bug 1691327 - Update sphinxcontrib-mermaid to v0.6.3 DONTBUILD. r=ahal
Differential Revision: https://phabricator.services.mozilla.com/D107057
2021-03-04 07:07:58 +00:00
championshuttler
029e008b15 Bug 1693140 - Fix the mermaid rendering issue and remove post processing script.r=sylvestre DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D105674
2021-02-19 08:45:10 +00:00
championshuttler
76dd0f5ab5 Bug 1684645 - Fix the regex for sphinx-copybutton.r=sylvestre DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D100596
2021-01-02 15:39:07 +00:00
Ricky Stewart
31b8ca9716 Bug 1654103: Standardize on Black for Python code in mozilla-central.
Allow-list all Python code in tree for use with the black linter, and re-format all code in-tree accordingly.

To produce this patch I did all of the following:

1. Make changes to tools/lint/black.yml to remove include: stanza and update list of source extensions.

2. Run ./mach lint --linter black --fix

3. Make some ad-hoc manual updates to python/mozbuild/mozbuild/test/configure/test_configure.py -- it has some hard-coded line numbers that the reformat breaks.

4. Make some ad-hoc manual updates to `testing/marionette/client/setup.py`, `testing/marionette/harness/setup.py`, and `testing/firefox-ui/harness/setup.py`, which have hard-coded regexes that break after the reformat.

5. Add a set of exclusions to black.yml. These will be deleted in a follow-up bug (1672023).

# ignore-this-changeset

Differential Revision: https://phabricator.services.mozilla.com/D94045
2020-10-26 18:34:53 +00:00
Bogdan Tara
612312a64c Backed out 10 changesets (bug 1654103, bug 1672023, bug 1518999) for PanZoomControllerTest.touchEventForResult gv-junit failures CLOSED TREE
Backed out changeset ff3fb0b4a512 (bug 1672023)
Backed out changeset e7834b600201 (bug 1654103)
Backed out changeset 807893ca8069 (bug 1518999)
Backed out changeset 13e6b92440e9 (bug 1518999)
Backed out changeset 8b2ac5a6c98a (bug 1518999)
Backed out changeset 575748295752 (bug 1518999)
Backed out changeset 65f07ce7b39b (bug 1518999)
Backed out changeset 4bb80556158d (bug 1518999)
Backed out changeset 8ac8461d7bd7 (bug 1518999)
Backed out changeset e8ba13ee17f5 (bug 1518999)
2020-10-24 03:36:18 +03:00
Ricky Stewart
065d2eb893 Bug 1654103: Standardize on Black for Python code in mozilla-central. r=remote-protocol-reviewers,marionette-reviewers,webdriver-reviewers,perftest-reviewers,devtools-backward-compat-reviewers,jgilbert,preferences-reviewers,sylvestre,maja_zf,webcompat-reviewers,denschub,ntim,whimboo,sparky
Allow-list all Python code in tree for use with the black linter, and re-format all code in-tree accordingly.

To produce this patch I did all of the following:

1. Make changes to tools/lint/black.yml to remove include: stanza and update list of source extensions.

2. Run ./mach lint --linter black --fix

3. Make some ad-hoc manual updates to python/mozbuild/mozbuild/test/configure/test_configure.py -- it has some hard-coded line numbers that the reformat breaks.

4. Make some ad-hoc manual updates to `testing/marionette/client/setup.py`, `testing/marionette/harness/setup.py`, and `testing/firefox-ui/harness/setup.py`, which have hard-coded regexes that break after the reformat.

5. Add a set of exclusions to black.yml. These will be deleted in a follow-up bug (1672023).

# ignore-this-changeset

Differential Revision: https://phabricator.services.mozilla.com/D94045
2020-10-23 20:40:42 +00:00