[−][src]Module rustdoc::html::static_files

Static files bundled with documentation output.

All the static files are included here for centralized access in case anything other than the HTML rendering code (say, the theme checker) needs to access one of these files.

Note about types: CSS and JavaScript files are included as &'static str to allow for the minifier to run on them. All other files are included as &'static [u8] so they can be directly written to a Write handle.

Modules

fira_sans

Files related to the Fira Sans font.

sidebar

Files related to the sidebar in rustdoc sources.

source_code_pro

Files related to the Source Code Pro font.

source_serif_pro

Files related to the Source Serif Pro font.

themes

The built-in themes given to every documentation site.

Statics

BRUSH_SVG

The file contents of brush.svg, the icon used for the theme-switch button.

COPYRIGHT

The contents of COPYRIGHT.txt, the license listing for files distributed with documentation output.

DOWN_ARROW_SVG

The file contents of down-arrow.svg, the icon used for the crate choice combobox.

LICENSE_APACHE

The contents of LICENSE-APACHE.txt, the text of the Apache License, version 2.0.

LICENSE_MIT

The contents of LICENSE-MIT.txt, the text of the MIT License.

MAIN_JS

The file contents of main.js, which contains the core JavaScript used on documentation pages, including search behavior and docblock folding, among others.

NORMALIZE_CSS

The file contents of normalize.css, included to even out standard elements between browser implementations.

NOSCRIPT_CSS

The file contents of the noscript.css file, used in case JS isn't supported or is disabled.

RUSTDOC_CSS

The file contents of the main rustdoc.css file, responsible for the core layout of the page.

RUST_FAVICON_PNG_16
RUST_FAVICON_PNG_32
RUST_FAVICON_SVG

The default documentation favicons (SVG and PNG fallbacks)

RUST_LOGO

The contents of rust-logo.png, the default icon of the documentation.

SETTINGS_CSS

The file contents of settings.css, responsible for the items on the settings page.

SETTINGS_JS

The file contents of settings.js, which contains the JavaScript used to handle the settings page.

STORAGE_JS

The file contents of storage.js, which contains functionality related to browser Local Storage, used to store documentation settings.

WHEEL_SVG

The file contents of wheel.svg, the icon used for the settings button.