gecko-dev/docs/config.yml
Mark Banner 7d064ab64e Bug 1923048 - Increase num of document generation warnings to resolve bustage. r=aryx DONTBUILD
Bug 1924903 introduced a new warning that we don't currently care about (document isn't included in any toctree), as the document
is linked to from other pages.

Differential Revision: https://phabricator.services.mozilla.com/D225959
2024-10-17 11:48:51 +00:00

150 lines
5.1 KiB
YAML

---
# The order of the main categories are defined in index.rst
# Sub categories orders are preserved
categories:
overview_doc:
- glossary
- overview
setup_doc:
- setup
contributing_doc:
- contributing
- bug-mgmt
user_guide:
- devtools-user
source_doc:
- mots
- browser
- dom
- editor
- layout
- gfx
- ipc
- devtools
- toolkit
- js
- mobile/android/geckoview
- mobile/android/fenix
- mobile/android/focus-android
- dom/bindings/webidl
- modules/libpref
- networking
- remote
- services
- uriloader
- widget/cocoa
- widget/windows
- toolkit/components/ml
- accessible
- code-quality
- writing-rust-code
- rust-components
- tools/profiler
- performance
- storage
- xpcom
- nspr
- security/nss
- content-security
build_doc:
- mach
- tools/try
- build/buildsystem
- taskcluster
- tools/moztreedocs
- mozbuild/vendor
testing_doc:
- testing/automated-testing
- testing/treeherder-try
- testing/sheriffed-intermittents
- testing/tests-for-new-config
- testing/intermittent
- testing/testing-policy
- testing/ci-configs
- testing/browser-chrome
- testing/chrome-tests
- testing/marionette
- testing/geckodriver
- testing/test-verification
- testing/webrender
- testing/mochitest-plain
- testing/xpcshell
- testing/tps
- web-platform
- gtest
- tools/fuzzing
- tools/sanitizer
- testing/perfdocs
- tools/code-coverage
- testing-rust-code
release_doc:
- update-infrastructure
l10n_doc:
- intl
- l10n
python_doc:
- mozbase
- python
fennec_doc:
- mobile/android
metrics_doc:
- metrics
redirects:
browser/browser: browser
browser/components/newtab/content-src/asrouter/docs: browser/components/newtab/docs
contributing/how_to_contribute_firefox.html: contributing/contribution_quickref.html
contributing/artifact_builds.html: contributing/build/artifact_builds.html
contributing/linux_build.html: setup/linux_build.html
contributing/build/linux_build.html: setup/linux_build.html
contributing/mercurial.html: contributing/vcs/mercurial.html
contributing/mercurial_bundles.html: contributing/vcs/mercurial_bundles.html
contributing/vscode.html: contributing/editors/vscode.html
dom/dom: dom
layout/layout: layout
gfx/gfx: gfx
intl/l10n/l10n: l10n
ipc/ipc: ipc
modules/libpref/libpref: modules/libpref
python/mach: mach
python/python: python
setup/getting_set_up.html: contributing/contributing_to_mozilla.html
taskcluster/taskcluster: taskcluster
testing/geckodriver/geckodriver: testing/geckodriver
testing/marionette/marionette: testing/marionette
toolkit/components/telemetry/telemetry: toolkit/components/telemetry
tools/compare-locales/index.html: build/buildsystem/locales.html
tools/docs/index.html: tools/moztreedocs/index.html
tools/docs/contribute/how_to_contribute_firefox.html: contributing/how_to_contribute_firefox.html
tools/docs/contribute/directory_structure.html: contributing/directory_structure.html
tools/lint: code-quality/lint
tools/lint/coding-style: code-quality/coding-style
tools/static-analysis/index.html: code-quality/static-analysis.html
fatal warnings:
- "WARNING: '([^']*)' reference target not found:((?!.rst).)*$"
- "WARNING: Include file '([^']*)' not found or reading it failed"
- "WARNING: Non-consecutive header level"
- "WARNING: Document headings start at"
- "WARNING: Parsing of expression failed"
- "WARNING: Title underline too short"
# A regexp of errors we currently allow so that we can fail on new errors,
# but resolve these at a later date. Please do not add new items to this list
# unless they are part of the existing known issues.
allowed_errors:
# Bug 1915552 - Various python errors around unexpected indentation.
- "mozbuild\\.vendor\\.moz_yaml\\.VALID_SOURCE_HOSTS.* ERROR: Unexpected indentation"
- "python/mozbuild/mozbuild/frontend/context\\.py.* ERROR: Unexpected indentation"
- "python/mozbuild/mozbuild/backend/configenvironment\\.py.* ERROR: Unexpected indentation"
- "python/mozbuild/mozbuild/vendor/rewrite_mozbuild\\.py.* ERROR: Unexpected indentation"
- "python/mozbuild/mozpack/errors\\.py.* ERROR: Unexpected indentation"
- "python/mozbuild/mozpack/mozjar\\.py.* ERROR: Unexpected indentation"
# Bug 1915274 - General issues in nss docs.
- "security/nss/releases/nss_3_90\\.rst.* ERROR: Content block expected for the \"container\" directive"
- "security/nss/releases/nss_3_94\\.rst.* ERROR: Unknown target name:"
- "security/nss/getting_started\\.rst.* CRITICAL: Unexpected section title"
max_num_warnings: 782