config.yml (8886B)
1 --- 2 3 # The order of the main categories are defined in index.rst 4 # Sub categories orders are preserved 5 categories: 6 overview_doc: 7 - glossary 8 - overview 9 setup_doc: 10 - setup 11 contributing_doc: 12 - contributing 13 - bug-mgmt 14 user_guide: 15 - devtools-user 16 source_doc: 17 - mots 18 - browser 19 - dom 20 - editor 21 - layout 22 - gfx 23 - ipc 24 - devtools 25 - toolkit 26 - js 27 - jsloader 28 - mobile/android/geckoview 29 - mobile/android/fenix 30 - mobile/android/focus-android 31 - dom/bindings/webidl 32 - modules/libpref 33 - networking 34 - remote 35 - services 36 - permissions 37 - uriloader 38 - widget/cocoa 39 - widget/windows 40 - toolkit/components/ml 41 - accessible 42 - media 43 - code-quality 44 - writing-rust-code 45 - rust-components 46 - tools/profiler 47 - performance 48 - storage 49 - xpcom 50 - nspr 51 - security/nss 52 - content-security 53 build_doc: 54 - mach 55 - tools/try 56 - build/buildsystem 57 - taskcluster 58 - tools/moztreedocs 59 - mozbuild/vendor 60 testing_doc: 61 - testing/automated-testing 62 - testing/treeherder-try 63 - testing/sheriffed-intermittents 64 - testing/tests-for-new-config 65 - testing/intermittent 66 - testing/debugging-intermittents 67 - testing/testing-policy 68 - testing/ci-configs 69 - testing/browser-chrome 70 - testing/chrome-tests 71 - testing/marionette 72 - testing/geckodriver 73 - testing/test-verification 74 - testing/webrender 75 - testing/mochitest-plain 76 - testing/xpcshell 77 - testing/tps 78 - web-platform 79 - gtest 80 - tools/fuzzing 81 - tools/sanitizer 82 - testing/perfdocs 83 - tools/code-coverage 84 - testing-rust-code 85 release_doc: 86 - update-infrastructure 87 - tools/update-verify 88 l10n_doc: 89 - intl 90 - l10n 91 python_doc: 92 - mozbase 93 - python 94 fennec_doc: 95 - mobile/android 96 metrics_doc: 97 - metrics 98 99 redirects: 100 browser/browser: browser 101 browser/components/newtab/docs/index.html: browser/extensions/newtab/docs/index.html 102 contributing/how_to_contribute_firefox.html: contributing/contribution_quickref.html 103 contributing/artifact_builds.html: contributing/build/artifact_builds.html 104 contributing/linux_build.html: setup/linux_build.html 105 contributing/build/linux_build.html: setup/linux_build.html 106 contributing/vscode.html: contributing/editors/vscode.html 107 dom/dom: dom 108 layout/layout: layout 109 gfx/gfx: gfx 110 intl/l10n/l10n: l10n 111 ipc/ipc: ipc 112 modules/libpref/libpref: modules/libpref 113 python/mach: mach 114 python/python: python 115 setup/getting_set_up.html: contributing/contributing_to_mozilla.html 116 taskcluster/taskcluster: taskcluster 117 testing/geckodriver/geckodriver: testing/geckodriver 118 testing/marionette/marionette: testing/marionette 119 toolkit/components/telemetry/telemetry: toolkit/components/telemetry 120 tools/compare-locales/index.html: build/buildsystem/locales.html 121 tools/docs/index.html: tools/moztreedocs/index.html 122 tools/docs/contribute/how_to_contribute_firefox.html: contributing/how_to_contribute_firefox.html 123 tools/docs/contribute/directory_structure.html: contributing/directory_structure.html 124 tools/lint: code-quality/lint 125 tools/lint/coding-style: code-quality/coding-style 126 tools/static-analysis/index.html: code-quality/static-analysis.html 127 128 # Please do not add more exceptions to these warnings. Generally they should be 129 # fixable. If you need help please ask in the firefox-source-docs channel on Matrix. 130 allowed_warnings: 131 # General warnings that need consideration/fixing. 132 - "WARNING: document isn't included in any toctree" 133 - "WARNING: duplicate label" 134 - "WARNING: local id not found in doc" 135 - "WARNING: 'myst' cross-reference target not found" 136 - "WARNING: Lexing literal_block" 137 - "WARNING: dot command 'dot' cannot be run \\(needed for graphviz output\\)" 138 # Specific warnings allowed when the allow list was created. 139 - "accessible/HCMMediaQueries\\.md:.*: WARNING: Lexing literal_block" 140 - "bug-pipeline\\.rst:.*: WARNING: Duplicate explicit target name" 141 - "devtools-user/web_console/remoting/index\\.rst:.*: WARNING: Duplicate explicit target name" 142 - "dom/navigation/BrowsingContext\\.rst:.*: WARNING: Duplicate explicit target name" 143 - "ipc/ipdl\\.rst:.*: WARNING: Duplicate explicit target name" 144 - "ipc/processes\\.rst:.*: WARNING: Duplicate explicit target name" 145 - "js/Debugger/Debugger\\.md:.*: WARNING: Duplicate reference definition" 146 - "l10n/migrations/localizations\\.rst:.* ERROR: Anonymous hyperlink mismatch" 147 - "mobile/android/geckoview/contributor/geckoview-architecture\\.rst:.*: WARNING: Duplicate explicit target name" 148 - "networking/http/prioritization\\.md:.*: ERROR: At least one body element must separate transitions" 149 - "networking/http/prioritization\\.md:.*: ERROR: Document may not end with a transition" 150 - "overview/index\\.rst:.*: WARNING: toctree contains reference to nonexisting document 'mobile/android/overview'" 151 - "testing/automated-testing/manifest-sandbox\\.rst:.*: WARNING: download file not readable" 152 - "UITour-lib.Mozilla.UITour.* WARNING: duplicate class description of Mozilla.UITour" 153 - "mobile/android/shared/android/device_testing\\.md:.*: WARNING: Pygments lexer name" 154 - "widget/windows/windows-pointing-device/index.rst:229: WARNING: image file not readable" 155 # Unknown document warnings 156 - "devtools-user/3d_view/index\\.rst:.*: WARNING: unknown document" 157 - "devtools-user/debugger-api/index\\.rst:.*: WARNING: unknown document" 158 - "devtools-user/memory/aggregate_view/index\\.rst:.*: WARNING: unknown document" 159 - "devtools-user/migrating_from_firebug/index\\.rst:.*: WARNING: unknown document" 160 - "devtools-user/network_monitor/index\\.rst:.*: WARNING: unknown document" 161 - "devtools-user/tips/index\\.rst:.*: WARNING: unknown document" 162 - "devtools-user/tools_toolbox/index\\.rst:.*: WARNING: unknown document" 163 # Undefined label warnings. 164 - "code-quality/.*\\.rst:.*: WARNING: undefined label" 165 - "contributing/.*\\.rst:.*: WARNING: undefined label" 166 - "crash-reporting/index\\.rst:.*: WARNING: undefined label" 167 - "dom/navigation/nav_replace\\.rst:.*: WARNING: undefined label" 168 - "devtools-user/page_inspector/how_to/work_with_animations/index.rst:.*: WARNING: undefined label" 169 - "js/build\\.rst:.*: WARNING: undefined label" 170 - "layout/Reftest\\.rst:.*: WARNING: undefined label" 171 - "mots/index.rst:.*: WARNING: undefined label" 172 - "nspr/.* WARNING: undefined label" 173 - "overview/gecko\\.rst:.*: WARNING: undefined label" 174 - "setup/configuring_build_options\\.rst:.*: WARNING: undefined label" 175 - "setup/windows_build\\.rst:.*: WARNING: undefined label" 176 - "taskcluster/release-promotion-action\\.rst:.*: WARNING: undefined label" 177 - "toolkit/components/messaging-system/docs/index\\.rst:.*: WARNING: undefined label" 178 - "toolkit/components/telemetry/collection/events\\.rst:.*: WARNING: undefined label" 179 - "toolkit/mozapps/extensions/addon-manager/AMRemoteSettings-overview\\.rst:.*: WARNING: undefined label" 180 - "tools/fuzzing/fuzzing_interface\\.rst:.*: WARNING: undefined label" 181 - "tools/try/selectors/chooser\\.rst:.*: WARNING: undefined label" 182 - "tools/try/tasks\\.rst:.*: WARNING: undefined label" 183 # Bug 1915274 - Clean up documentation warnings in NSS 184 - "security/nss/.* WARNING: undefined label" 185 # Various python issues 186 - "\\.py:.*: ERROR: Unexpected indentation." 187 - "\\.py:.* WARNING: duplicate object description" 188 - "docstring of mozbuild.vendor.moz_yaml.VALID_SOURCE_HOSTS:.*: ERROR: Unexpected indentation." 189 - "docstring of mozbuild.vendor.moz_yaml.VALID_SOURCE_HOSTS:.*: WARNING: Inline emphasis start-string without end-string" 190 - "process_define_file:.*: WARNING: Inline emphasis start-string without end-string" 191 - "docstring of marionette_driver.*: WARNING: Field list ends without a blank line" 192 - "missing attribute .* in object mozprocess.ProcessHandlerMixin" 193 - "WARNING: autodoc: failed to import module" 194 - "WARNING: invalid signature for automodule \\('mozbuild.action.xpidl-process'\\)" 195 - "WARNING: don't know which module to import for autodocumenting" 196 # This file has various warnings that need investigation. 197 - "python/mozbuild/mozbuild/frontend/context\\.py" 198 # mozbuild.sphinx extension warnings. 199 - "WARNING: the mozbuild.sphinx extension does not declare" 200 - "WARNING: doing serial read"