doc.yml (4382B)
1 # This Source Code Form is subject to the terms of the Mozilla Public 2 # License, v. 2.0. If a copy of the MPL was not distributed with this 3 # file, You can obtain one at http://mozilla.org/MPL/2.0/. 4 --- 5 generate: 6 description: Generate the Sphinx documentation 7 index: 8 # Searchfox needs a fixed URL for the artifacts to download the latest 9 # trees.json file. 10 product: source 11 job-name: doc-generate 12 use-python: "3.11" 13 platform: doc/opt 14 treeherder: 15 symbol: doc(generate) 16 kind: test 17 tier: 1 18 run-on-repo-type: [hg] 19 run-on-projects: ['trunk'] 20 worker-type: b-linux-medium 21 worker: 22 docker-image: {in-tree: "lint"} 23 max-run-time: 1800 24 env: 25 LC_ALL: C 26 # Define various variables to make the generation happy and not 27 # output `KeyError`s. 28 # 29 # This occurs when sphinx is processing some of the python, and 30 # there is processing going on at the top level. It shows up in 31 # automation because there's no build environment setup, and so 32 # the python code can't work out what these variables should be. 33 # Hence in defining them here we can work around the issue. 34 OS_TARGET: Linux 35 BIN_SUFFIX: "" 36 DLL_PREFIX: "" 37 DLL_SUFFIX: "" 38 artifacts: 39 - type: file 40 name: public/docs.tar.gz 41 path: /builds/worker/checkouts/gecko/docs-out/main.tar.gz 42 - type: file 43 name: public/trees.json 44 path: /builds/worker/artifacts/trees.json 45 run: 46 using: run-task 47 cwd: '{checkout}' 48 command: > 49 cp -r $MOZ_FETCHES_DIR/node_modules node_modules && 50 ln -s ../tools/lint/eslint/eslint-plugin-mozilla node_modules && 51 ln -s ../tools/lint/eslint/eslint-plugin-spidermonkey-js node_modules && 52 ./mach doc --outdir docs-out --no-open --no-serve --archive --dump-trees=/builds/worker/artifacts/trees.json 53 sparse-profile: sphinx-docs 54 optimization: 55 skip-unless-schedules: [docs] 56 fetches: 57 toolchain: 58 - linux64-node 59 - node-modules 60 61 62 upload: 63 description: Generate and upload the Sphinx documentation 64 use-python: "3.11" 65 platform: doc/opt 66 attributes: 67 code-review: true 68 treeherder: 69 symbol: doc(upload) 70 kind: test 71 tier: 2 72 run-on-projects: [mozilla-central-only] 73 worker-type: b-linux-medium 74 worker: 75 docker-image: {in-tree: "lint"} 76 max-run-time: 2400 77 env: 78 LC_ALL: C 79 MOZ_SOURCE_DOCS_USE_GOOGLE: "1" 80 # Define various variables to make the generation happy and not 81 # output `KeyError`s. 82 # 83 # This occurs when sphinx is processing some of the python, and 84 # there is processing going on at the top level. It shows up in 85 # automation because there's no build environment setup, and so 86 # the python code can't work out what these variables should be. 87 # Hence in defining them here we can work around the issue. 88 OS_TARGET: Linux 89 BIN_SUFFIX: "" 90 DLL_PREFIX: "" 91 DLL_SUFFIX: "" 92 taskcluster-proxy: true 93 artifacts: 94 - type: file 95 name: public/firefox-source-docs-url.txt 96 path: /builds/worker/firefox-source-docs-url.txt 97 - type: file 98 name: public/trees.json 99 path: /builds/worker/artifacts/trees.json 100 run: 101 using: run-task 102 cwd: '{checkout}' 103 command: > 104 cp -r $MOZ_FETCHES_DIR/node_modules node_modules && 105 ln -s ../tools/lint/eslint/eslint-plugin-mozilla node_modules && 106 ln -s ../tools/lint/eslint/eslint-plugin-spidermonkey-js node_modules && 107 ./mach doc --upload --no-open --no-serve --write-url /builds/worker/firefox-source-docs-url.txt --dump-trees=/builds/worker/artifacts/trees.json 108 sparse-profile: sphinx-docs 109 scopes: 110 - secrets:get:project/releng/gecko/build/level-{level}/gecko-docs-upload 111 optimization: 112 skip-unless-schedules: [docs] 113 fetches: 114 toolchain: 115 - linux64-node 116 - node-modules