Files
sousa-gecko/build/sparse-profiles/sphinx-docs
T
James Han a5768cedb0 Bug 2011450 - Add Sphinx extension to auto-generate ETP capability matrix r=manuel
Added a Sphinx extension that auto-generates comprehensive documentation of
Firefox desktop privacy features from source files.

The extension parses browser/app/profile/firefox.js, modules/libpref/init/all.js,
and modules/libpref/init/StaticPrefList.yaml to extract pref values and generates
browser/components/protections/docs/etp-matrix.md during the doc build.

Output includes:
- ETP Standard and Strict mode tables showing which features are enabled in
  normal vs private browsing
- 7 additional privacy feature sections: Safe Browsing, Private Browsing,
  Cookie Behavior, Privacy Headers, Fingerprinting Resistance, Anti-fraud,
  and Other Privacy Features
- Quick Navigation section linking to all categories
- Technical descriptions for each feature with Searchfox links to prefs
- Mode values for BTP and Cookie Behavior (e.g., "Mode 3 (stateful)", "Mode 5 (dFPI)")
- Infrastructure for Nightly and Early Beta footnotes

Differential Revision: https://phabricator.services.mozilla.com/D281665
2026-02-27 16:22:48 +00:00

60 lines
1.4 KiB
Plaintext

%include build/sparse-profiles/mach
[include]
# List of dependencies for the command
path:python/sites/docs.txt
path:taskcluster/requirements.txt
# Code for generating docs.
glob:docs/**
glob:tools/moztreedocs/**
# For icons
glob:browser/branding/nightly/**
# Potential docs sources
glob:**/*.rst
glob:**/*.md
glob:**/*.mjs
glob:**/*.js
glob:**/*.json
# Potential included images. We don't glob all paths in order to avoid importing
# images unrelated to documentation (like branding or test images)
glob:**/docs/**.jpg
glob:**/docs/**.png
glob:**/docs/**.svg
glob:**/docs/**.gif
glob:**/devtools/**.gif
glob:**/devtools-user/**.gif
glob:**/Debugger/**.png
glob:**/Debugger/**.svg
# Include everything found in the perfdocs generated folder
glob:testing/perfdocs/generated/**
# Python API docs.
glob:**/*.py
# Referenced by some python files.
path:taskcluster/kinds/docker-image/kind.yml
# Included in ipc docs
path:ipc/ipdl/test/ipdl/ok/PMyManaged.ipdl
path:ipc/ipdl/test/ipdl/ok/PMyManager.ipdl
path:ipc/ipdl/test/ipdl/ok/MyTypes.ipdlh
# moz.build files are read to discover location of docs.
glob:**/moz.build
# package*.json files are needed for node_modules
glob:**/package*.json
# Read to set the version of the docs.
path:config/milestone.txt
# mots configuration
path:mots.yaml
# ETP matrix generation needs pref definitions
path:modules/libpref/init/StaticPrefList.yaml