mirror of
https://github.com/mozilla-firefox/firefox
synced 2026-08-11 12:19:28 +00:00
Sylvestre Ledru
5edc1f63da
mots already supports Markdown output. Set mots.yaml export.format to md (with the export path pointing at docs/mots/index.md) and convert the RST roles in the description and module url fields to MyST-compatible syntax so the generated document renders correctly. docs/mots/index.md is produced by `mach mots export` as part of the build, so it is git-ignored rather than committed (replacing the old index.rst entry), and the codespell and documentation allow-lists are updated for the new filename. Differential Revision: https://phabricator.services.mozilla.com/D304216
97 lines
2.8 KiB
YAML
97 lines
2.8 KiB
YAML
---
|
|
codespell:
|
|
description: Check code for common misspellings
|
|
include:
|
|
- browser/branding/
|
|
- browser/components/asrouter/docs/
|
|
- browser/components/places/docs/
|
|
- browser/components/search/docs/
|
|
- browser/components/search/schema/
|
|
- browser/components/tabbrowser/docs/
|
|
- browser/components/touchbar/docs/
|
|
- browser/components/urlbar/docs/
|
|
- browser/extensions/newtab/docs/
|
|
- browser/installer/windows/docs/
|
|
- browser/locales/en-US/
|
|
- build/docs/
|
|
- devtools/client/locales/en-US/
|
|
- devtools/docs/
|
|
- devtools/shared/locales/en-US/
|
|
- devtools/startup/locales/en-US/
|
|
- docs/
|
|
- dom/docs/
|
|
- dom/locales/en-US/
|
|
- gfx/docs/
|
|
- intl/docs/
|
|
- intl/locales/en-US/
|
|
- ipc/docs/
|
|
- js/src/doc/
|
|
- layout/tools/layout-debug/ui/content/layoutdebug.ftl
|
|
- mobile/android/branding/
|
|
- mobile/android/docs/
|
|
- mobile/android/locales/en-US/
|
|
- netwerk/locales/en-US/
|
|
- netwerk/docs/
|
|
- python/docs/
|
|
- python/mach/docs/
|
|
- python/mozlint/
|
|
- python/mozperftest/perfdocs/
|
|
- remote/
|
|
- security/manager/locales/en-US/
|
|
- services/settings/docs/
|
|
- taskcluster/docs/
|
|
- testing/docs/xpcshell/
|
|
- testing/geckodriver/doc/
|
|
- testing/mozbase/docs/
|
|
- testing/raptor/raptor/perfdocs/
|
|
- toolkit/components/extensions/docs/
|
|
- toolkit/components/normandy/docs/
|
|
- toolkit/components/search/docs/
|
|
- toolkit/components/search/schema/
|
|
- toolkit/components/telemetry/docs/
|
|
- toolkit/crashreporter/docs/
|
|
- toolkit/docs/
|
|
- toolkit/locales/en-US/
|
|
- toolkit/modules/docs/
|
|
- tools/code-coverage/docs/
|
|
- tools/fuzzing/docs/
|
|
- tools/lint/
|
|
- tools/moztreedocs/
|
|
- tools/profiler/docs/
|
|
- tools/sanitizer/docs/
|
|
- tools/tryselect/
|
|
- uriloader/docs/
|
|
- xpcom/docs/
|
|
exclude:
|
|
- devtools/docs/contributor/tools/storage/
|
|
- docs/mots/index.*
|
|
- remote/test/puppeteer/
|
|
- tools/lint/cpp/mingw-headers.txt
|
|
- tools/lint/test/test_codespell.py
|
|
- "**/package-lock.json"
|
|
# List of extensions coming from:
|
|
# tools/lint/{flake8,eslint}.yml
|
|
# tools/mach_commands.py (clang-format)
|
|
# + documentation
|
|
# + localization files
|
|
extensions:
|
|
- js
|
|
- jsx
|
|
- mjs
|
|
- xml
|
|
- html
|
|
- xhtml
|
|
- cpp
|
|
- c
|
|
- h
|
|
- configure
|
|
- py
|
|
- properties
|
|
- rst
|
|
- md
|
|
- ftl
|
|
support-files:
|
|
- 'tools/lint/spell/**'
|
|
type: external
|
|
payload: spell:lint
|