@@ -58,10 +58,13 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)
58
58
* If you want to copy those docs to a webserver, copy all of
59
59
` build/host/doc ` , since that's where the CSS, JS, fonts, and landing
60
60
page are.
61
+ * For frontend debugging, disable the ` rust.docs-minification ` option in [ ` config.toml ` ] .
61
62
* Use ` ./x test tests/rustdoc* ` to run the tests using a stage1
62
63
rustdoc.
63
64
* See [ Rustdoc internals] for more information about tests.
64
65
66
+ [ `config.toml` ] : ./building/how-to-build-and-run.md
67
+
65
68
## Code structure
66
69
67
70
* All paths in this section are relative to ` src/librustdoc ` in the rust-lang/rust repository.
@@ -77,6 +80,7 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)
77
80
* The tests on the structure of rustdoc HTML output are located in ` tests/rustdoc ` , where
78
81
they're handled by the test runner of bootstrap and the supplementary script
79
82
` src/etc/htmldocck.py ` .
83
+ * Frontend CSS and JavaScript are stored in ` html/static/ ` .
80
84
81
85
## Tests
82
86
@@ -91,6 +95,11 @@ does is call the `main()` that's in this crate's `lib.rs`, though.)
91
95
browser-UI-test] ( https://github.com/GuillaumeGomez/browser-UI-test/ ) that uses
92
96
puppeteer to run tests in a headless browser and check rendering and
93
97
interactivity.
98
+ * Additionally, JavaScript type annotations are written using [ TypeScript-flavored JSDoc]
99
+ comments and an external d.ts file. The code itself is plain, valid JavaScript; we only
100
+ use tsc as a linter.
101
+
102
+ [ TypeScript-flavored JSDoc ] : https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
94
103
95
104
## Constraints
96
105
0 commit comments