Generate the `docs.rs` Documentation


Generate the `docs.rs` Documentation
Using a Dev Container feature
Other methods to preview the documentation HTML

Use just doc to generate the documentation for docs.rs.

cargo doc --open does not seem to work when running from a Dev Container in VS Code; the script that opens URLs into an external browser (see $ echo $BROWSER) does not handle raw HTML. Use python3 -m http.server 9000 or live server to serve the files instead. See the doc recipe in justfile⮳.

Using a Dev Container feature

Alternatively, use the "Desktop lite" Dev Container feature ⮳ to install a light GUI manager. Add the following to devcontainer.json:

"features": {
    "ghcr.io/devcontainers/features/desktop-lite:1": {}
},
"forwardPorts": [
    6080
],
"portsAttributes": {
    "6080": {
        "label": "desktop"
    }
},

and the following to the Dockerfile⮳

RUN apt-get update && export DEBIAN_FRONTEND=noninteractive && apt-get install -y firefox-esr

Optionally apt-get install xdg-utils to check that Firefox is the default for text/html:

xdg-mime query default text/html
# or for more details:
XDG_UTILS_DEBUG_LEVEL=2 xdg-mime query default text/html

xdg-settings --list
xdg-settings get default-web-browser

Point your browser to http://localhost:6080 and use vscode as the password. Open the HTML file of your choice with:

xdg-open /cargo-target-rust_howto/target/doc/deps/index.html

Rust How-to

Generate the docs.rs Documentation

Using a Dev Container feature

Other methods to preview the documentation HTML

Generate the `docs.rs` Documentation