diff --git a/templates/about-base.html b/templates/about-base.html index a7366f831..6c8861d14 100644 --- a/templates/about-base.html +++ b/templates/about-base.html @@ -1,42 +1,42 @@ -{% extends "base.html" %} +{%- extends "base.html" -%} {%- block body_classes -%} centered {%- endblock body_classes -%} -{% block header %} -
-
-
-

Docs.rs documentation

-
-
    - {% set text = "circle-info" | fas(fw=true) %} - {% set text = text ~ ' About' %} - {{ macros::active_link(expected="index", href="/about", text=text) }} +{%- block header -%} +
    {#- -#} +
    {#- -#} +
    {#- -#} +

    Docs.rs documentation

    {#- -#} +
    {#- -#} +
      {#- -#} + {%- set text = "circle-info" | fas(fw=true) -%} + {%- set text = text ~ ' About' -%} + {{- macros::active_link(expected="index", href="/about", text=text) -}} - {% set text = "fonticons" | fab(fw=true) %} - {% set text = text ~ ' Badges' %} - {{ macros::active_link(expected="badges", href="/about/badges", text=text) }} + {%- set text = "fonticons" | fab(fw=true) -%} + {%- set text = text ~ ' Badges' -%} + {{- macros::active_link(expected="badges", href="/about/badges", text=text) -}} - {% set text = "gears" | fas(fw=true) %} - {% set text = text ~ ' Builds' %} - {{ macros::active_link(expected="builds", href="/about/builds", text=text) }} + {%- set text = "gears" | fas(fw=true) -%} + {%- set text = text ~ ' Builds' -%} + {{- macros::active_link(expected="builds", href="/about/builds", text=text) -}} - {% set text = "table" | fas(fw=true) %} - {% set text = text ~ ' Metadata' %} - {{ macros::active_link(expected="metadata", href="/about/metadata", text=text) }} + {%- set text = "table" | fas(fw=true) -%} + {%- set text = text ~ ' Metadata' -%} + {{- macros::active_link(expected="metadata", href="/about/metadata", text=text) -}} - {% set text = "road" | fas(fw=true) %} - {% set text = text ~ ' Shorthand URLs' %} - {{ macros::active_link(expected="redirections", href="/about/redirections", text=text) }} + {%- set text = "road" | fas(fw=true) -%} + {%- set text = text ~ ' Shorthand URLs' -%} + {{- macros::active_link(expected="redirections", href="/about/redirections", text=text) -}} - {% set text = "download" | fas(fw=true) %} - {% set text = text ~ ' Download' %} - {{ macros::active_link(expected="download", href="/about/download", text=text) }} -
    -
    -
    -
    -
    -{% endblock %} + {%- set text = "download" | fas(fw=true) -%} + {%- set text = text ~ ' Download' -%} + {{- macros::active_link(expected="download", href="/about/download", text=text) -}} +
{#- -#} +
{#- -#} +
{#- -#} +
{#- -#} +
{#- -#} +{%- endblock -%} diff --git a/templates/base.html b/templates/base.html index 6f3fb9ba8..04f73c7af 100644 --- a/templates/base.html +++ b/templates/base.html @@ -1,30 +1,30 @@ {%- import "macros.html" as macros -%} - - + {#- -#} + {#- -#} - - - - + {#- -#} + {#- -#} + {#- -#} + {#- #} {%- block meta -%}{%- endblock meta -%} - {# Docs.rs styles #} - - + {# Docs.rs styles -#} + {#- -#} + {#- -#} - + {#- -#} - {%- block title -%} Docs.rs {%- endblock title -%} + {%- block title -%} Docs.rs {%- endblock title -%} {#- -#} - + {#- #} {%- block css -%}{%- endblock css -%} - - - + {#- -#} + {#- -#} + {#- -#} - + {#- -#} {%- block topbar -%} {%- include "header/topbar.html" -%} {%- endblock topbar -%} @@ -34,5 +34,5 @@ {%- block body -%}{%- endblock body -%} {%- block javascript -%}{%- endblock javascript -%} - + {#- -#} diff --git a/templates/core/about/badges.html b/templates/core/about/badges.html index 762fc807d..37bb9ce17 100644 --- a/templates/core/about/badges.html +++ b/templates/core/about/badges.html @@ -1,11 +1,11 @@ -{% extends "about-base.html" -%} +{%- extends "about-base.html" -%} {%- block title -%} Badges {%- endblock title -%} {%- block body -%} -

Badges

+

Badges

{#- -#} -
-

Docs.rs no longer has its own badges. Consider using shields.io instead.

+
{#- -#} +

Docs.rs no longer has its own badges. Consider using shields.io instead.

{#- -#}
-{%- endblock body %} +{%- endblock body -%} diff --git a/templates/core/about/builds.html b/templates/core/about/builds.html index 93a47f7f3..7d8daf3c3 100644 --- a/templates/core/about/builds.html +++ b/templates/core/about/builds.html @@ -1,109 +1,109 @@ -{% extends "about-base.html" -%} +{%- extends "about-base.html" -%} {%- block title -%} Builds {%- endblock title -%} {%- block body -%} {%- set docsrs_repo = "https://github.com/rust-lang/docs.rs" -%} -

Builds

-
-
-

- Docs.rs automatically builds documentation for crates released on crates.io. - - It may take a while to build your crate, depending on how many crates are in the queue. -

- -

- All crates are built in a sandbox using the nightly release of the Rust compiler. - {%- if rustc_version %} +

Builds

{#- -#} +
{#- -#} +
{#- -#} +

{#- -#} + Docs.rs automatically builds documentation for crates released on crates.io. {# -#} + + It may take a while to build your crate, depending on how many crates are in the queue. {#- -#} +

{#- -#} + +

{#- -#} + All crates are built in a sandbox using the nightly release of the Rust compiler. {# -#} + {%- if rustc_version -%} The current version in use is {{ rustc_version }}. {%- endif -%} -

+

{#- -#} -

Notes on using Docs.rs

+

Notes on using Docs.rs

{#- -#} -

Setting a README

-

- The README of a crate is taken from the readme field defined in - Cargo.toml. If this field is not set, no README will be displayed. -

+

Setting a README

{#- -#} +

{#- -#} + The README of a crate is taken from the readme field defined in {# -#} + Cargo.toml. If this field is not set, no README will be displayed. {#- -#} +

{#- -#} -

Detecting Docs.rs

-

- To recognize Docs.rs from build.rs files, you can test for the environment variable DOCS_RS, e.g.: - {% filter highlight(lang="rust") %}{% filter dedent(levels=3) -%} +

Detecting Docs.rs

{#- -#} +

{#- -#} + To recognize Docs.rs from build.rs files, you can test for the environment variable DOCS_RS, e.g.: {# -#} + {%- filter highlight(lang="rust") %}{% filter dedent(levels=3) -%} if std::env::var("DOCS_RS").is_ok() { // ... your code here ... } - {%- endfilter %}{% endfilter %} - This approach can be helpful if you need dependencies for building the library, but not for building the documentation. -

+ {%- endfilter %}{% endfilter -%} + This approach can be helpful if you need dependencies for building the library, but not for building the documentation. {#- -#} +

{#- -#} -

Cross-compiling

-

- All targets other than x86_64-unknown-linux-gnu are cross-compiled. For implementation reasons, this is unlikely to change for the foreseeable future. -

+

Cross-compiling

{#- -#} +

{#- -#} + All targets other than x86_64-unknown-linux-gnu are cross-compiled. For implementation reasons, this is unlikely to change for the foreseeable future. {#- -#} +

{#- -#} -

+

{#- -#} You can configure how your crate is built by adding package metadata to your Cargo.toml, e.g.: - {% filter highlight(lang="toml") %}{% filter dedent -%} + {%- filter highlight(lang="toml") %}{% filter dedent -%} [package.metadata.docs.rs] rustc-args = ["--cfg", "docsrs"] - {%- endfilter %}{% endfilter %} - Here, the compiler arguments are set so that #[cfg(docsrs)] (not to be confused with #[cfg(doc)]) can be used for conditional compilation. - This approach is also useful for setting cargo features. -

+ {%- endfilter %}{% endfilter -%} + Here, the compiler arguments are set so that #[cfg(docsrs)] (not to be confused with #[cfg(doc)]) can be used for conditional compilation. {# -#} + This approach is also useful for setting cargo features. {#- -#} +

{#- -#}

Testing documentation builds locally

{%- set build_subcommand = docsrs_repo ~ "/blob/master/README.md#build-subcommand" -%} -

- The Docs.rs README describes how to build - unpublished crate documentation locally using the same build environment as the Docs.rs build agent. -

- -

Diagnosing failed builds

- -

Missing dependencies

-

- Missing dependencies are a common reason for failed builds. - Docs.rs dependencies are managed through - crates-build-env. - See Forge for how to add a dependency. -

- -

Write attempt on read-only directories

-

- Most of the sandbox is a read-only file system, including the source directory of your crate and its dependencies. - If your build.rs generates files that are relevant for documentation, consider writing to the - cargo output directory, - passed in the environment variable OUT_DIR. -

- -

Hitting resource limits

-

- All the builds are executed inside a sandbox with limited resources. The current limits are: +

{#- -#} + The Docs.rs README describes how to build {# -#} + unpublished crate documentation locally using the same build environment as the Docs.rs build agent. {#- -#} +

{#- -#} + +

Diagnosing failed builds

{#- -#} + +

Missing dependencies

{#- -#} +

{#- -#} + Missing dependencies are a common reason for failed builds. {# -#} + Docs.rs dependencies are managed through {# -#} + crates-build-env. {# -#} + See Forge for how to add a dependency. {#- -#} +

{#- -#} + +

Write attempt on read-only directories

{#- -#} +

{#- -#} + Most of the sandbox is a read-only file system, including the source directory of your crate and its dependencies. {# -#} + If your build.rs generates files that are relevant for documentation, consider writing to the {# -#} + cargo output directory, {# -#} + passed in the environment variable OUT_DIR. {#- -#} +

{#- -#} + +

Hitting resource limits

{#- -#} +

{#- -#} + All the builds are executed inside a sandbox with limited resources. The current limits are: {#- -#}

- {{ macros::crate_limits(limits=limits) }} - -

- If your build fails because it hit one of these limits, please - open an issue - to get them increased for your crate. - Since our build agent has finite resources, we have to consider each case individually. However, there are a few general policies: -

    -
  • Network access will not be enabled for any crate.
    • -
  • Any crate that requests a time extension will be limited to one target.
    • -
-

- -

Other failures and requesting rebuilds

-

- If your crate fails to build for a reason not listed here, please file an issue. - Some build failures can be fixed by Docs.rs, e.g., by issuing a rebuild after a bug in Docs.rs has been fixed. -

- -
-
+ {{- macros::crate_limits(limits=limits) -}} + +

{#- -#} + If your build fails because it hit one of these limits, please {# -#} + open an issue {# -#} + to get them increased for your crate. {# -#} + Since our build agent has finite resources, we have to consider each case individually. However, there are a few general policies: {#- -#} +

    {#- -#} +
  • Network access will not be enabled for any crate.
    • {#- -#} +
  • Any crate that requests a time extension will be limited to one target.
    • {#- -#} +
{#- -#} +

{#- -#} + +

Other failures and requesting rebuilds

{#- -#} +

{#- -#} + If your crate fails to build for a reason not listed here, please file an issue. {# -#} + Some build failures can be fixed by Docs.rs, e.g., by issuing a rebuild after a bug in Docs.rs has been fixed. {# -#} +

{#- -#} + +
{#- -#} +
{#- -#}
-{%- endblock body %} +{%- endblock body -%} diff --git a/templates/core/about/download.html b/templates/core/about/download.html index 4fb14fdff..4851c7334 100644 --- a/templates/core/about/download.html +++ b/templates/core/about/download.html @@ -1,63 +1,63 @@ -{% extends "about-base.html" -%} +{%- extends "about-base.html" -%} {%- block title -%} Download {%- endblock title -%} {%- block body -%} -

Documentation download

+

Documentation download

{#- -#} -
-
-

- docs.rs stores the rustdoc output in a ZIP file. -

-

- These archives can be used as a base for further processing of - the documentation for offline readers like Dash or Zeal. - They are not directly usable for offline documentation. -

-

URLs

-

- The download is possible for specific or semantic versions: -

+
{#- -#} +
{#- -#} +

{#- -#} + docs.rs stores the rustdoc output in a ZIP file. {#- -#} +

{#- -#} +

{#- -#} + These archives can be used as a base for further processing of {# -#} + the documentation for offline readers like Dash or Zeal. {# -#} + They are not directly usable for offline documentation. {#- -#} +

{#- -#} +

URLs

{#- -#} +

{#- -#} + The download is possible for specific or semantic versions: {# -#} +

{#- -#} - But also via - docs.rs/crate/clap/latest/download - to get the latest version. -

-

processing / caveats

-

- To unpack the ZIP file you need any zip utility that supports - PKZIP version 4.6 and BZIP2 compression. -

-

- The archives will contain all the documentation HTML files for all - targets and CSS/JS assets that are specific to the build. The default - target will be found at the root, and other targets each in its own - subfolder. -

-

- Docs.rs is running rustdoc with --static-root-path "/-/rustdoc.static/", - which leads to all references to static assets breaking if they are not - available under that path. Older builds used --static-root-path "/", which - means you will have to handle both. -

-

- Since we're also adding --emit=invocation-specific to our build - the archives will not contain any static assets that are specific to the - toolchain. For now these will have to be downloaded file-by-file directly - from docs.rs. -

-
+ But also via {# -#} + docs.rs/crate/clap/latest/download {#- -#} + to get the latest version. {#- -#} +

{#- -#} +

processing / caveats

{#- -#} +

{#- -#} + To unpack the ZIP file you need any zip utility that supports {# -#} + PKZIP version 4.6 and BZIP2 compression. {#- -#} +

{#- -#} +

{#- -#} + The archives will contain all the documentation HTML files for all {# -#} + targets and CSS/JS assets that are specific to the build. The default {# -#} + target will be found at the root, and other targets each in its own {# -#} + subfolder. {# -#} +

{#- -#} +

{#- -#} + Docs.rs is running rustdoc with --static-root-path "/-/rustdoc.static/", {# -#} + which leads to all references to static assets breaking if they are not {# -#} + available under that path. Older builds used --static-root-path "/", which {# -#} + means you will have to handle both. {#- -#} +

{#- -#} +

{#- -#} + Since we're also adding --emit=invocation-specific to our build {# -#} + the archives will not contain any static assets that are specific to the {# -#} + toolchain. For now these will have to be downloaded file-by-file directly {# -#} + from docs.rs. {# -#} +

{#- -#} +
{#- -#}
-{%- endblock body %} +{%- endblock body -%} diff --git a/templates/core/about/index.html b/templates/core/about/index.html index 91851a299..e64e3896f 100644 --- a/templates/core/about/index.html +++ b/templates/core/about/index.html @@ -1,52 +1,51 @@ -{% extends "about-base.html" -%} +{%- extends "about-base.html" -%} {%- block title -%} About Docs.rs {%- endblock title -%} {%- block body -%} {%- set docsrs_repo = "https://github.com/rust-lang/docs.rs" -%} -

About Docs.rs

-
-
-

- Docs.rs is an - open source - documentation host for crates of the - Rust Programming Language. - All libraries published to crates.io - are documented. If you just published a crate, your crate is likely - still in the queue. -

- -

- The source code of Docs.rs is available on - GitHub. If - you ever encounter an issue, don't hesitate to report it! (And - thanks in advance!) -

- - -

More about Docs.rs

-
    -
  1. Badges: How to use badges generated by Docs.rs
    2. -
  2. Builds: How Docs.rs builds documentation for a crate
    3. -
  3. Metadata: How you can configure a build
    4. -
  4. Redirections: How Docs.rs uses semantic versioning in URLs
    5. -
- -

Version

-

Currently running Docs.rs version is: {{ docsrs_version() }}

- -

Version

-

Summaries of the documentation build processes are available at /releases/.

+

About Docs.rs

{#- -#} +
{#- -#} +
{#- -#} +

{#- -#} + Docs.rs is an {# -#} + open source {# -#} + documentation host for crates of the {# -#} + Rust Programming Language. {# -#} + All libraries published to crates.io {# -#} + are documented. If you just published a crate, your crate is likely {# -#} + still in the queue. {#- -#} +

{#- -#} + +

{#- -#} + The source code of Docs.rs is available on {# -#} + GitHub. If {# -#} + you ever encounter an issue, don't hesitate to report it! (And {# -#} + thanks in advance!) {#- -#} +

{#- -#} + +

More about Docs.rs

{#- -#} +
    {#- -#} +
  1. Badges: How to use badges generated by Docs.rs
    2. {#- -#} +
  2. Builds: How Docs.rs builds documentation for a crate
    3. {#- -#} +
  3. Metadata: How you can configure a build
    4. {#- -#} +
  4. Redirections: How Docs.rs uses semantic versioning in URLs
    5. {#- -#} +
{#- -#} + +

Version

{#- -#} +

Currently running Docs.rs version is: {{ docsrs_version() }}

{#- -#} + +

Version

{#- -#} +

Summaries of the documentation build processes are available at /releases/.

{#- -#}

Contact

{%- set governance_link = "https://www.rust-lang.org/governance/teams/dev-tools#docs-rs" -%} -

- Docs.rs is run and maintained by the Docs.rs team. - You can find us in #t-docs-rs on Zulip. -

+

{#- -#} + Docs.rs is run and maintained by the Docs.rs team. {# -#} + You can find us in #t-docs-rs on Zulip. {#- -#} +

{#- -#} +
{#- -#}
-
-{%- endblock body %} +{%- endblock body -%} diff --git a/templates/core/about/metadata.html b/templates/core/about/metadata.html index 99880d42b..cbf5851fa 100644 --- a/templates/core/about/metadata.html +++ b/templates/core/about/metadata.html @@ -1,22 +1,22 @@ -{% extends "about-base.html" -%} +{%- extends "about-base.html" -%} {%- block title -%} Metadata {%- endblock title -%} {%- block body -%} -

Metadata for custom builds

+

Metadata for custom builds

{#- -#} -
-
-

- You can customize docs.rs builds by defining [package.metadata.docs.rs] - table in your crates' Cargo.toml. -

+
{#- -#} +
{#- -#} +

{#- -#} + You can customize docs.rs builds by defining [package.metadata.docs.rs] {# -#} + table in your crates' Cargo.toml. {#- -#} +

{#- -#} -

The available configuration flags you can customize are:

+

The available configuration flags you can customize are:

{#- -#} - {% filter highlight(lang="toml") %} + {%- filter highlight(lang="toml") -%} {%- include "core/Cargo.toml.example" -%} - {% endfilter %} -
-
-{%- endblock body %} + {%- endfilter -%} +
{#- -#} +
{#- -#} +{%- endblock body -%} diff --git a/templates/core/about/redirections.html b/templates/core/about/redirections.html index fea36be5f..023aae3ab 100644 --- a/templates/core/about/redirections.html +++ b/templates/core/about/redirections.html @@ -1,67 +1,67 @@ -{% extends "about-base.html" -%} +{%- extends "about-base.html" -%} {%- block title -%} Shorthand URLs {%- endblock title -%} {%- block body -%} -

Shorthand URLs

+

Shorthand URLs

{#- -#} -
-
-

- Docs.rs uses semver to parse URLs. You can use this feature to access - crates' documentation easily. Example of URL redirections for - clap crate: -

+
{#- -#} +
{#- -#} +

{#- -#} + Docs.rs uses semver to parse URLs. You can use this feature to access {# -#} + crates' documentation easily. Example of URL redirections for {# -#} + clap crate: {#- -#} +

{#- -#} - - - - - - - +
URLRedirects to documentation of
{#- -#} + {#- -#} + {#- -#} + {#- -#} + {#- -#} + {#- -#} + {#- -#} - - - - - + {#- -#} + {#- -#} + {#- -#} + {#- -#} + {#- -#} - - - - + {#- -#} + {#- -#} + {#- -#} + {#- -#} - - - - + {#- -#} + {#- -#} + {#- -#} + {#- -#} - - - - + {#- -#} + {#- -#} + {#- -#} + {#- -#} - - - {#- -#} + {#- -#} + - - -
URLRedirects to documentation of
docs.rs/clapLatest version of clap
docs.rs/clapLatest version of clap
- docs.rs/clap/~2 - 2.* version
{#- -#} + docs.rs/clap/~2 {#- -#} + 2.* version
- docs.rs/clap/~2.9 - 2.9.* version
{#- -#} + docs.rs/clap/~2.9 {#- -#} + 2.9.* version
- docs.rs/clap/2.9.3 - - 2.9.3 version (you don't need = unlike semver) -
{#- -#} + docs.rs/clap/2.9.3 {#- -#} + {#- -#} + 2.9.3 version (you don't need = unlike semver) {#- -#} +
- docs.rs/clap/* - +
{#- -#} + docs.rs/clap/* {#- -#} + {#- -#} Latest version of this page (if it still exists). "latest" or "newest" work as well as - *. -
-
-
+ {#- -#} *. {#- -#} + {#- -#} + {#- -#} + {#- -#} + {#- -#} +
{#- -#} +
{#- -#}
{%- endblock body %} diff --git a/templates/core/home.html b/templates/core/home.html index a99fb6edc..3d8abf0bc 100644 --- a/templates/core/home.html +++ b/templates/core/home.html @@ -7,34 +7,34 @@ {%- endblock body_classes -%} {%- block body -%} -
-

{{ "cubes" | fas(fw=true) }} Docs.rs

+
{#- -#} +

{{ "cubes" | fas(fw=true) }} Docs.rs

{#- -#} -
-
- -
+ {#- -#} +
{#- -#} + {#- -#} +
{#- -#} -
- +
{#- -#} + {#- -#} -
- -
+ {#- -#} I'm Feeling Lucky {#- -#} + {#- -#} +
{#- -#} + {#- -#} +
{#- -#} -
-
-
- - Recent Releases - +
{#- -#} +
{#- -#} +
{#- -#} + {#- -#} + Recent Releases {#- -#} + {#- -#} - {{ "square-rss" | fas }} - -
+ {{- "square-rss" | fas -}} + {#- -#} +
{#- -#}
- +
{#- -#} + {#- -#} {%- endfor -%} - -
+ {#- -#} +
{#- -#}
{%- endblock body -%} diff --git a/templates/crate/build_details.html b/templates/crate/build_details.html index e5a634b91..d69bb668e 100644 --- a/templates/crate/build_details.html +++ b/templates/crate/build_details.html @@ -2,7 +2,7 @@ {%- import "header/package_navigation.html" as navigation -%} {%- block title -%} - {{ macros::doc_title(name=metadata.name, version=metadata.version) }} + {{- macros::doc_title(name=metadata.name, version=metadata.version) -}} {%- endblock title -%} {%- block body_classes -%} @@ -20,27 +20,27 @@ {%- endblock topbar -%} {%- block header -%} - {{ navigation::package_navigation(metadata=metadata, active_tab="builds") }} + {{- navigation::package_navigation(metadata=metadata, active_tab="builds") -}} {%- endblock header -%} {%- block body -%} -
-
-
- Build #{{ build_details.id }} {{ build_details.build_time | date(format="%+") }} +
{#- -#} +
{#- -#} +
{#- -#} + Build #{{ build_details.id }} {{ build_details.build_time | date(format="%+") }} {#- -#}
{%- filter dedent -%} - 
-                    # rustc version
-                    {{ build_details.rustc_version }}
-                    # docs.rs version
-                    {{ build_details.docsrs_version }}
+                
 {#- -#}
+# rustc version
+{{ build_details.rustc_version }}
+# docs.rs version
+{{ build_details.docsrs_version }}
 
-                    # build log
-                    {{ build_details.output }}
+# build log
+{{ build_details.output -}}
                 

             {%- endfilter -%}
-
-
+
{#- -#} +
{#- -#} {%- endblock body -%} diff --git a/templates/crate/builds.html b/templates/crate/builds.html index 72c97f13c..5ece0589b 100644 --- a/templates/crate/builds.html +++ b/templates/crate/builds.html @@ -28,54 +28,54 @@ {%- endblock header -%} {%- block body -%} -
-
-
- Builds -
+
{#- -#} +
{#- -#} +
{#- -#} + Builds {#- -#} +
{#- -#} -
{#- -#} +
{{ build.rustc_version }}
{#- -#} +
{{ build.docsrs_version }}
{#- -#} +
{{ build.build_time | timeformat(relative=true) }}
{#- -#} +
{#- -#} + {#- -#} {%- endfor -%} - + {#- -#}
- {# BuildsPage.metadata is an `Option`, so accessing it can fail #} + {#- BuildsPage.metadata is an `Option`, so accessing it can fail -#} {%- if metadata -%}

{{ metadata.name }}'s sandbox limits

{%- else -%}

Sandbox limits

{%- endif -%} -

- All the builds on docs.rs are executed inside a sandbox with limited - resources. The limits for this crate are the following: +

{#- -#} + All the builds on docs.rs are executed inside a sandbox with limited {# -#} + resources. The limits for this crate are the following: {# -#}

- {{ macros::crate_limits(limits=limits) }} + {{- macros::crate_limits(limits=limits) -}} -

- If a build fails because it hit one of those limits please - open an issue - to get them increased. -

-
-
+

{#- -#} + If a build fails because it hit one of those limits please {# -#} + open an issue {# -#} + to get them increased. {#- -#} +

{#- -#} +
{#- -#} +
{#- -#}
{%- endblock body -%} diff --git a/templates/crate/details.html b/templates/crate/details.html index bf8c280bf..c9cf7de25 100644 --- a/templates/crate/details.html +++ b/templates/crate/details.html @@ -22,20 +22,20 @@ {%- endblock topbar -%} {%- block header -%} - {# Set the active tab to the `crate` tab #} - {{ navigation::package_navigation(metadata=details.metadata, active_tab="crate") }} + {#- Set the active tab to the `crate` tab -#} + {{- navigation::package_navigation(metadata=details.metadata, active_tab="crate") -}} {%- endblock header -%} {%- block body -%} -
-
-
-
+
{#- -#} +
{#- -#} +
{#- -#} +
{#- -#} {#- -#} +
{#- -#} + {#- -#} -
  • Versions
    • -
  • -
    +
  • Versions
    • {#- -#} +
  • {#- -#} +
    {#- -#}
      - {# Display all releases of this crate #} - {{ macros::releases_list(name=details.name, releases=details.releases, target="", inner_path="") }} -
    -
    + {#- Display all releases of this crate -#} + {{- macros::releases_list(name=details.name, releases=details.releases, target="", inner_path="") -}} + {#- -#} +
    • {#- -#} - {# Display the crate owner's profile picture and a link to their docs.rs profile #} -
  • Owners
    • + {#- Display the crate owner's profile picture and a link to their docs.rs profile -#} +
  • Owners
    • {#- -#}
  • {%- for owner in details.owners -%} - - {{ owner[0] }} + {#- -#} + {{ owner[0] }} {#- -#} {%- endfor -%} -
    • - -
    -
    + {#- -#} + {#- -#} +
    {#- -#} +
    {#- -#}
    - {# If the release is not a library #} + {#- If the release is not a library -#} {%- if not details.is_library -%}
    - {{ details.name }}-{{ details.version }} is not a library. + {{- details.name }}-{{ details.version }} is not a library. {#- -#}
    - {# If the release has been yanked and is a library #} + {#- If the release has been yanked and is a library -#} {%- elif details.yanked -%}
    - {{ details.name }}-{{ details.version }} has been yanked. + {{- details.name }}-{{ details.version }} has been yanked. {#- -#}
    - {# If the build succeeded, isn't yanked and is a library #} + {#- If the build succeeded, isn't yanked and is a library -#} {%- elif details.build_status -%} - {# If there are no docs display a warning #} + {#- If there are no docs display a warning -#} {%- if not details.rustdoc_status -%}
    {{ details.name }}-{{ details.version }} doesn't have any documentation.
    {%- endif -%} - {# If the build failed, the release isn't yanked and the release is a library #} + {#- If the build failed, the release isn't yanked and the release is a library -#} {%- else -%} - {# Display a warning telling the user we failed to build the docs #} -
    - docs.rs failed to build {{ details.name }}-{{ details.version }} -
    - Please check the - build logs for more information. -
    - See Builds for ideas on how to fix a failed build, - or Metadata for how to configure docs.rs builds. -
    - If you believe this is docs.rs' fault, open an issue. + {#- Display a warning telling the user we failed to build the docs -#} +
    {#- -#} + docs.rs failed to build {{ details.name }}-{{ details.version }} {#- -#} +
    {#- -#} + Please check the {#+ -#} + build logs for more information. {#- -#} +
    {#- -#} + See Builds for ideas on how to fix a failed build, {#+ -#} + or Metadata for how to configure docs.rs builds. {#- -#} +
    {#- -#} + If you believe this is docs.rs' fault, open an issue. {#- -#}
    - {# If there is one, display the most next most recent successful build #} + {#- If there is one, display the most next most recent successful build -#} {%- if details.last_successful_build -%} -
    - Visit the last successful build: +
    {#- -#} + Visit the last successful build: {#+ -#} - {{ details.name }}-{{ details.last_successful_build }} - + {{- details.name }}-{{ details.last_successful_build -}} + {#- -#}
    {%- endif -%} {%- endif -%} - {# If there's a readme, display it #} + {#- If there's a readme, display it -#} {%- if details.readme -%} - {{ details.readme | safe }} + {{- details.readme | safe -}} {# If there's not a readme then attempt to display the long description #} {%- elif details.rustdoc -%} - {{ details.rustdoc | safe }} + {{- details.rustdoc | safe -}} {%- endif -%} -
    -
    -
    +
    {#- -#} +
    {#- -#} +
    {#- -#} {%- endblock body -%} diff --git a/templates/crate/features.html b/templates/crate/features.html index c7125ccce..3bc01c44c 100644 --- a/templates/crate/features.html +++ b/templates/crate/features.html @@ -20,56 +20,56 @@ {%- endblock topbar -%} {%- block header -%} - {{ navigation::package_navigation(metadata=metadata, active_tab="features") }} + {{- navigation::package_navigation(metadata=metadata, active_tab="features") -}} {%- endblock header -%} {%- block body -%} -
    -
    -
    -
    -
      +
      {#- -#} +
      {#- -#} +
      {#- -#} +
      {#- -#} +
        {#- -#}
      • Feature flags
        • {%- if features -%} {%- for feature in features -%} -
      • +
      • {#- -#} - {{ feature.name }} - + {{- feature.name -}} + {#- -#}
        • {%- endfor -%} {%- elif features is iterable -%} -
      • - This release does not have any feature flags. +
      • {#- -#} + This release does not have any feature flags. {#- -#}
        • {%- else -%} -
      • - Feature flags are not available for this release because it was built before features were collected by docs.rs. +
      • {#- -#} + Feature flags are not available for this release because it was built before features were collected by docs.rs. {#- -#}
        • {%- endif -%} -
      -
      -
      +
    {#- -#} +
    {#- -#} +
    {#- -#} -
    -

    {{ metadata.name }}

    -
    - There is very little structured metadata to build this page - from currently. You should check the - main library docs, - readme, or - Cargo.toml - in case the author documented the features in them. +
    {#- -#} +

    {{ metadata.name }}

    {#- -#} +
    {#- -#} + There is very little structured metadata to build this page {# -#} + from currently. You should check the {# -#} + main library docs, {# -#} + readme, or {# -#} + Cargo.toml {# -#} + in case the author documented the features in them. {#- -#}
    {%- if features -%}

    This version has {{ features | length }} feature flags, {{ default_len }} of them enabled by default.

    {%- for feature in features -%} -

    {{ feature.name }}

    +

    {{ feature.name }}

    {#- -#}
      {%- if feature.subfeatures -%} {%- for subfeature in feature.subfeatures -%} -
    • - {{ subfeature }} +
    • {#- -#} + {{ subfeature }} {#- -#}
      • {%- endfor -%} {%- else -%} @@ -82,7 +82,7 @@

      {{ feature.name }}

      {%- else -%}

      Feature flags are not available for this release because it was built before features were collected by docs.rs.

      {%- endif -%} -
    -
    +
    {#- -#} +
    {#- -#}
    {%- endblock body -%} diff --git a/templates/crate/source.html b/templates/crate/source.html index a4781338e..49126db4d 100644 --- a/templates/crate/source.html +++ b/templates/crate/source.html @@ -2,7 +2,7 @@ {%- import "header/package_navigation.html" as navigation -%} {%- block title -%} - {{ macros::doc_title(name=file_list.metadata.name, version=file_list.metadata.version) }} + {{- macros::doc_title(name=file_list.metadata.name, version=file_list.metadata.version) -}} {%- endblock title -%} {%- block topbar -%} @@ -17,8 +17,8 @@ {%- endblock topbar -%} {%- block header -%} - {# Set the active tab to the `source` tab #} - {{ navigation::package_navigation(metadata=file_list.metadata, active_tab="source") }} + {#- Set the active tab to the `source` tab -#} + {{- navigation::package_navigation(metadata=file_list.metadata, active_tab="source") -}} {%- endblock header -%} {%- block body_classes -%} @@ -26,52 +26,52 @@ {%- endblock body_classes -%} {%- block body -%} -
    -
    -
    -
    +
    {#- -#} +
    {#- -#} +
    {#- -#} +
    {#- -#} -
    + {#- -#} +
    {#- -#}
    - {# If the file has content, then display it in a codeblock #} + {#- If the file has content, then display it in a codeblock -#} {%- if file_content -%}
    {{- file_content | highlight(lang=file.name) -}}
    {%- endif -%} -
    +
    {#- -#}
    {%- endblock body -%} {%- block javascript -%} - {% if file_content %} + {%- if file_content -%} - {% endif %} + {%- endif -%} {%- endblock javascript -%} diff --git a/templates/error.html b/templates/error.html index e7685ecf8..c77ae90e0 100644 --- a/templates/error.html +++ b/templates/error.html @@ -1,12 +1,12 @@ {%- extends "base.html" -%} {%- block header -%} -
    -
    -

    {{ title }}

    -
    -
    +
    {#- -#} +
    {#- -#} +

    {{ title }}

    {#- -#} +
    {#- -#} +
    {#- -#}
    - {{ message | default(value="") }} + {{- message | default(value="") -}}
    {%- endblock header -%} diff --git a/templates/header/global_alert.html b/templates/header/global_alert.html index 6f7dbb731..4e7997218 100644 --- a/templates/header/global_alert.html +++ b/templates/header/global_alert.html @@ -1,12 +1,11 @@ -{# Get the current global alert #} +{#- Get the current global alert -#} {%- set global_alert = global_alert() -%} -{# If there is a global alert, render it #} +{#- If there is a global alert, render it -#} {%- if global_alert -%} -
  • +
  • {#- -#} - {{ global_alert.fa_icon | fas }} - {{ global_alert.text }} - -
    • + {{- global_alert.fa_icon | fas }} {{ global_alert.text -}} + {#- -#} + {#- -#} {%- endif -%} diff --git a/templates/header/package_navigation.html b/templates/header/package_navigation.html index ca7ed028a..312d4e183 100644 --- a/templates/header/package_navigation.html +++ b/templates/header/package_navigation.html @@ -1,4 +1,4 @@ -{# +{#- The standard package navigation menu * `title` A possibly-null string. If it is null, `metadata.name metadata.version` will be used as the title @@ -11,79 +11,78 @@ Note: `false` here is acting as a pseudo-null value since you can't directly construct null values and tera requires all parameters without defaults to be filled -#} -{% macro package_navigation(title=false, metadata, active_tab) %} -
    -
    +-#} +{%- macro package_navigation(title=false, metadata, active_tab) -%} +
    {#- -#} +
    {#- -#}
    - {# The partial path of the crate, `:name/:release` #} + {#- The partial path of the crate, `:name/:release` -#} {%- set crate_path = metadata.name ~ "/" ~ metadata.version_or_latest -%} - {# If docs are built, show a button for them #} + {#- If docs are built, show a button for them -#} - {# Page title #} + {#- Page title -#}

    {%- if title -%} - {{ title }} + {{- title -}} {%- else -%} - {{ metadata.name }} {{ metadata.version }} + {{- metadata.name }} {{ metadata.version }} {# -#} {%- include "clipboard.svg" -%} {%- endif -%}

    - {# Page description #} + {#- Page description -#}
    {%- if metadata.description -%} - {{ metadata.description }} + {{- metadata.description -}} {%- endif -%} -
    +
    {#- -#} - -
    +
    {#- -#} -
    + {{- "flag" | fas -}} + Feature flags {#- -#} + {#- -#} + {#- -#} + {#- -#} +
    {#- -#}
    {%- if metadata.rustdoc_status -%} - {{ "book" | fas(fw=true) }} Documentation + {{- "book" | fas(fw=true) }} Documentation {#- -#} {%- endif -%} -
    +
    {#- -#}
    -{% endmacro package_navigation %} +{%- endmacro package_navigation -%} diff --git a/templates/header/topbar_begin.html b/templates/header/topbar_begin.html index c28e5ed4d..8e4db4748 100644 --- a/templates/header/topbar_begin.html +++ b/templates/header/topbar_begin.html @@ -1,21 +1,21 @@ -{# +{#- This is the unchanging top bar that is on every single page. The only piece of context it can take is `search_query`, which should be a string and will populate the search field if it exists -#} -
    -
    - {#- -#} + {#- -#} +
    {#- -#} +
    {#- -#} +
    {#- -#} diff --git a/templates/macros.html b/templates/macros.html index 8ee4fc0e9..d0f25b633 100644 --- a/templates/macros.html +++ b/templates/macros.html @@ -1,84 +1,84 @@ -{# +{#- Creates a list entry for active tabs. When the active tab is the same as `expected`, it will show the current tab as active. * `expected` A string that represents the current tab, when `active_tab == expected` the current will be shown as active * `href` A string used as the tab's link * `text` A string used as the tab's text -#} -{% macro active_link(expected, href, text) %} -
  • +-#} +{%- macro active_link(expected, href, text) -%} +
  • {#- -#} - {# safe: allow passing in HTML #} - {{ text | safe }} - + {#- safe: allow passing in HTML -#} + {{- text | safe -}} + {#- -#}
    • -{% endmacro active_link %} +{%- endmacro active_link -%} -{# +{#- Creates a list entry * `href` A string used as the tab's link * `text` A string used as the tab's text * `target` An optional target * `extra_classes` Optional extra css classes -#} -{% macro menu_link(href, text, target="", extra_classes="") %} -
  • +-#} +{%- macro menu_link(href, text, target="", extra_classes="") -%} +
  • {#- -#} - {{ text }} - + {{- text -}} + {#- -#}
    • -{% endmacro active_link %} +{%- endmacro active_link -%} -{# +{#- Creates a formatted table showing the resource limits of a crate * `limits` A non-null `Limits` struct -#} -{% macro crate_limits(limits) %} - - - - - - +-#} +{%- macro crate_limits(limits) -%} +
    Available RAM{{ limits.memory | filesizeformat }}
    {#- -#} + {#- -#} + {#- -#} + {#- -#} + {#- -#} + {#- -#} - - - - + {#- -#} + {#- -#} + {#- -#} + {#- -#} - - - - + {#- -#} + {#- -#} + {#- -#} + {#- -#} - - + {#- -#} + {#- -#} - + {#- -#} + {#- -#} - - - - - + {#- -#} + {#- -#} + {#- -#} + {#- -#} + {#- -#}
    Available RAM{{ limits.memory | filesizeformat }}
    Maximum rustdoc execution time{{ limits.timeout.secs | timeformat }}
    Maximum rustdoc execution time{{ limits.timeout.secs | timeformat }}
    Maximum size of a build log{{ limits.max_log_size | filesizeformat }}
    Maximum size of a build log{{ limits.max_log_size | filesizeformat }}
    Network access
    Network access {%- if limits.networking -%} allowed {%- else -%} blocked {%- endif -%} -
    Maximum number of build targets{{ limits.targets }}
    Maximum number of build targets{{ limits.targets }}
    -{% endmacro crate_limits %} +{%- endmacro crate_limits -%} -{# Constructs a title based on the given crate name and version #} -{% macro doc_title(name, version) %} +{#- Constructs a title based on the given crate name and version -#} +{%- macro doc_title(name, version) -%} {%- if name -%} {{ name }} {{ version | default(value="") }} - Docs.rs {%- else -%} Docs.rs {%- endif -%} -{% endmacro doc_title %} +{%- endmacro doc_title -%} -{# +{#- Constructs a list of a crate's releases * `name` The crate's name as a string * `releases` A list of crate releases where each release has the following fields: @@ -88,51 +88,51 @@ * `is_library` A boolean that's true if the crate is a library and false if it's a binary * `target` The target platform (empty string if the default or a `/crate` page) * `inner_path` The current rustdoc page (empty string if a `/crate` page) -#} -{% macro releases_list(name, releases, target, inner_path) %} +-#} +{%- macro releases_list(name, releases, target, inner_path) -%} {%- for release in releases -%} - {# The url for the release, `/crate/:name/:version` #} - {# NOTE: `/` is part of target if it exists (to avoid `target-direct//path`) #} - {% if inner_path == "" %} {# /crate #} + {#- The url for the release, `/crate/:name/:version` -#} + {#- NOTE: `/` is part of target if it exists (to avoid `target-direct//path`) -#} + {%- if inner_path == "" -%} {#- /crate -#} {%- set release_url = "/crate/" ~ name ~ "/" ~ release.version -%} {%- set retain_fragment = false -%} - {% else %} + {%- else -%} {%- set release_url = "/crate/" ~ name ~ "/" ~ release.version ~ "/target-redirect/" ~ target ~ inner_path -%} {%- set retain_fragment = true -%} - {% endif %} - {# The release's name and version, `:name-:version` #} + {%- endif -%} + {#- The release's name and version, `:name-:version` -#} {%- set release_name = name ~ "-" ~ release.version -%} {%- if not release.is_library -%} - {# If the release isn't a library, then display that warning #} + {#- If the release isn't a library, then display that warning -#} {%- set warning = release_name ~ " is not a library" -%} {%- elif release.yanked and release.build_status -%} - {# If the release has been yanked and failed to build, display a warning #} + {#- If the release has been yanked and failed to build, display a warning -#} {%- set warning = release_name ~ " is yanked" -%} {%- elif release.yanked and not release.build_status -%} - {# If the release has been yanked and failed to build, display a warning #} + {#- If the release has been yanked and failed to build, display a warning -#} {%- set warning = release_name ~ " is yanked and docs.rs failed to build it" -%} {%- elif not release.build_status -%} - {# If the release failed to build, display a warning #} + {#- If the release failed to build, display a warning -#} {%- set warning = "docs.rs failed to build " ~ release_name -%} {%- else -%} {%- set warning = false -%} {%- endif -%} -
  • - {#- -#} + - {% if warning %} - {{ "triangle-exclamation" | fas(fw=true) }} - {% endif %} - {{ release.version }} - + {%- if warning -%} + {{- "triangle-exclamation" | fas(fw=true) }} {# -#} + {%- endif -%} + {{- release.version -}} + {#- -#}
    • {%- endfor -%} -{% endmacro releases_list %} +{%- endmacro releases_list -%} diff --git a/templates/releases/activity.html b/templates/releases/activity.html index 56b0f2d8a..3654363d8 100644 --- a/templates/releases/activity.html +++ b/templates/releases/activity.html @@ -4,62 +4,62 @@ {%- block title -%}Releases - Docs.rs{%- endblock title -%} {%- block header -%} - {{ release_macros::header(title="Releases", description=description, tab="activity") }} + {{- release_macros::header(title="Releases", description=description, tab="activity") -}} {%- endblock header -%} {%- block body -%} -
    - +
    {#- -#} + {#- -#}
    {%- endblock body -%} -{# TODO: Do this with tera alone #} +{#- TODO: Do this with tera alone -#} {%- block css -%} {%- endblock -%} {%- block javascript -%} - + {#- -#} {%- endblock javascript -%} diff --git a/templates/releases/build_queue.html b/templates/releases/build_queue.html index 73834dce3..3798665ef 100644 --- a/templates/releases/build_queue.html +++ b/templates/releases/build_queue.html @@ -4,62 +4,62 @@ {%- block title -%}Queue - Docs.rs{%- endblock title -%} {%- block header -%} - {{ release_macros::header(title="Queue", description=description, tab="queue") }} + {{- release_macros::header(title="Queue", description=description, tab="queue") -}} {%- endblock header -%} {%- block body -%} -
    +
    {#- -#}
    - {%- if active_deployments %} -
    - active CDN deployments -
    + {%- if active_deployments -%} +
    {#- -#} + active CDN deployments {#- -#} +
    {#- -#} -
    -
    +
    {#- -#} +
    {#- -#}
      - {% for krate in active_deployments -%} -
    1. + {%- for krate in active_deployments -%} +
    2. {#- -#} - {{ krate }} - + {{- krate -}} + {#- -#}
      3. {%- endfor %} -
    -
    -
    -
    -

    - After the build finishes it may take up to 20 minutes for all documentation - pages to be up-to-date and available to everybody. -

    -

    Especially /latest/ URLs might be affected.

    -
    -
    + {#- -#} +
    {#- -#} +
    {#- -#} +
    {#- -#} +

    {#- -#} + After the build finishes it may take up to 20 minutes for all documentation {# -#} + pages to be up-to-date and available to everybody. {#- -#} +

    {#- -#} +

    Especially /latest/ URLs might be affected.

    {#- -#} +
    {#- -#} +
    {#- -#}
    {%- endif %} -
    - Build Queue -
    +
    {#- -#} + Build Queue {#- -#} +
    {#- -#}
      {%- if queue -%} - {% for crate in queue -%} -
    1. + {%- for crate in queue -%} +
    2. {#- -#} - {{ crate.name }} {{ crate.version }} + {{- crate.name }} {{ crate.version -}} - {% if crate.priority != 0 -%} + {%- if crate.priority != 0 -%} (priority: {{ crate.priority }}) {%- endif %}
      3. {%- endfor %} - {%- else %} + {%- else -%} There is nothing in the queue - {%- endif %} -
    -
    + {%- endif -%} + {#- -#} +
    {#- -#}
    {%- endblock body -%} diff --git a/templates/releases/feed.xml b/templates/releases/feed.xml index 6801ade89..266246397 100644 --- a/templates/releases/feed.xml +++ b/templates/releases/feed.xml @@ -1,14 +1,14 @@ - - - Docs.rs - Recent Rust crates + {#- -#} + {#- -#} + Docs.rs {#- -#} + Recent Rust crates {#- -#} - - - - + {#- -#} + {#- -#} + {#- -#} + {#- -#} - urn:docs-rs:{{ docsrs_version() }} + urn:docs-rs:{{ docsrs_version() }} {#- -#} {{ recent_releases[0].build_time | default(value=now()) | date(format="%+") }} {%- for release in recent_releases -%} @@ -18,20 +18,20 @@ {%- set link = "/crate/" ~ release.name ~ "/" ~ release.version -%} {%- endif %} - - {{ release.name }}-{{ release.version }} + {#- -#} + {{ release.name }}-{{ release.version }} {#- -#} - - urn:docs-rs:{{ release.name }}:{{ release.version }} - {{ release.build_time | date(format="%+") }} + {#- -#} + urn:docs-rs:{{ release.name }}:{{ release.version }} {#- -#} + {{ release.build_time | date(format="%+") }} {#- -#} - {{ release.description | default(value="") | escape_xml }} - + {{- release.description | default(value="") | escape_xml -}} + {#- -#} - - docs.rs - - + {#- -#} + docs.rs {#- -#} + {#- -#} + {#- -#} {%- endfor %} - + {#- -#} diff --git a/templates/releases/header.html b/templates/releases/header.html index 8792a55c2..63c36238c 100644 --- a/templates/releases/header.html +++ b/templates/releases/header.html @@ -1,4 +1,4 @@ -{# +{#- Builds the header for the release dashboard * `title` A string * `description` A string @@ -10,75 +10,75 @@ * `activity` * `queue` * `owner` A string, used for the owners page -#} -{% macro header(title, description, tab, owner=false) %} -
    -
    -
    -

    {{ title }}

    +-#} +{%- macro header(title, description, tab, owner=false) -%} +
    {#- -#} +
    {#- -#} +
    {#- -#} +

    {{ title }}

    {#- -#}
    {{ description | default(value="") }}
    - {# This does double-duty as the search, so hide all tabs when we're searching something #} + {#- This does double-duty as the search, so hide all tabs when we're searching something -#} {%- if tab != "search" -%} -
    - {#- -#}
    {%- endif -%} -
    -
    +
    {#- -#} +
    {#- -#}
    -{% endmacro header %} +{%- endmacro header -%} diff --git a/templates/releases/releases.html b/templates/releases/releases.html index f31e7fe0e..00c71c4c6 100644 --- a/templates/releases/releases.html +++ b/templates/releases/releases.html @@ -4,15 +4,15 @@ {%- block title -%}{{ title | default(value="Releases - Docs.rs")}}{%- endblock title -%} {%- block header -%} - {# These all have defaults so searches work #} - {{ + {#- These all have defaults so searches work -#} + {{- release_macros::header( title=title | default(value="Releases"), description=description | default(value=""), tab=release_type, owner=owner | default(value=false) ) - }} + -}} {%- endblock header -%} {%- block body_classes -%} @@ -20,62 +20,61 @@ {%- endblock body_classes -%} {%- block body -%} -
    -
    +
    {#- -#} +
    {#- -#}
    - +
    {#- -#} + {#- -#} {%- endfor -%} - + {#- -#} -
    + {%- endblock pagination -%} +
    {#- -#} +
    {#- -#}
    {%- endblock body -%} diff --git a/templates/releases/search_results.html b/templates/releases/search_results.html index 1bdb164df..9f7f117e2 100644 --- a/templates/releases/search_results.html +++ b/templates/releases/search_results.html @@ -1,15 +1,15 @@ {%- extends "releases/releases.html" -%} -{% block pagination %} +{%- block pagination -%} {%- if previous_page_link -%} - {{ "arrow-left" | fas }} Previous Page + {{- "arrow-left" | fas }} Previous Page {#- -#} {%- endif -%} {%- if next_page_link -%} - - Next Page {{ "arrow-right" | fas }} + {#- -#} + Next Page {{ "arrow-right" | fas -}} {%- endif -%} -{% endblock pagination %} +{%- endblock pagination -%} diff --git a/templates/rustdoc/body.html b/templates/rustdoc/body.html index 7fa746bf6..78751c5cb 100644 --- a/templates/rustdoc/body.html +++ b/templates/rustdoc/body.html @@ -1,4 +1,4 @@ - + {#- -#} -{# see comment in ../storage-change-detection.html for details #} - +{#- see comment in ../storage-change-detection.html for details -#} + {#- -#} diff --git a/templates/rustdoc/head.html b/templates/rustdoc/head.html index f3678c940..7ecca7bc9 100644 --- a/templates/rustdoc/head.html +++ b/templates/rustdoc/head.html @@ -1,6 +1,4 @@ {%- import "macros.html" as macros -%} - - - - - + {#- -#} + {#- -#} + {#- -#} diff --git a/templates/rustdoc/platforms.html b/templates/rustdoc/platforms.html index 67e0cb167..75acb7ffd 100644 --- a/templates/rustdoc/platforms.html +++ b/templates/rustdoc/platforms.html @@ -1,9 +1,9 @@ {%- for target in metadata.doc_targets -%} - {# + {#- The crate-detail page is the only page where we want to allow google to follow the target-links. On that page we also don't have to use `/target-redirect/` because the documentation root page is guaranteed to exist for all targets. - #} + -#} {%- if use_direct_platform_links -%} {%- set target_url = "/" ~ metadata.name ~ "/" ~ metadata.version_or_latest ~ "/" ~ target ~ "/" ~ inner_path -%} {%- set target_no_follow = "" -%} @@ -17,9 +17,9 @@ {%- set current = "" -%} {%- endif -%} -
  • +
  • {#- -#} {{- target -}} - + {#- -#}
    • {%- endfor -%} diff --git a/templates/rustdoc/releases.html b/templates/rustdoc/releases.html index 7772dcbf9..7d96b17cd 100644 --- a/templates/rustdoc/releases.html +++ b/templates/rustdoc/releases.html @@ -1,6 +1,6 @@ -{% import "macros.html" as macros %} -{% set target = "" %} -{% set inner_path = releases[0].target_name ~ "/index.html" %} +{%- import "macros.html" as macros -%} +{%- set target = "" -%} +{%- set inner_path = releases[0].target_name ~ "/index.html" -%}
      -{{ macros::releases_list(name=crate_name, releases=releases, target=target, inner_path=inner_path) }} -
    +{{- macros::releases_list(name=crate_name, releases=releases, target=target, inner_path=inner_path) -}} + {#- -#} diff --git a/templates/rustdoc/topbar.html b/templates/rustdoc/topbar.html index 10e9fb4da..3d0a0f95c 100644 --- a/templates/rustdoc/topbar.html +++ b/templates/rustdoc/topbar.html @@ -1,182 +1,182 @@ {%- import "macros.html" as macros -%} -{# The url of the current release, `/crate/:name/:version` #} +{#- The url of the current release, `/crate/:name/:version` -#} {%- set crate_url = "/crate/" ~ metadata.name ~ "/" ~ metadata.version_or_latest -%} {%- include "header/topbar_begin.html" -%}{# extra whitespace unremovable, need to use html tags unaffacted by whitespace T_T #} {#- -#} +
    {#- -#} +
    {#- -#} -
    -
    -
      +
      {#- -#} +
      {#- -#} +
        {#- -#}
      • Dependencies
        • - {# Display all dependencies that the crate has #} -
      • -
        + {#- Display all dependencies that the crate has -#} +
      • {#- -#} +
        {#- -#} -
        -
        • -
      -
      - -
      -
        -
      • Versions
        • - -
      • - -
        • -
      -
      +
    {#- -#} +
    {#- -#} + {#- -#} + {#- -#} +
    {#- -#} + +
    {#- -#} +
      {#- -#} +
    • Versions
      • {#- -#} + +
    • {#- -#} + {#- -#} +
      • {#- -#} +
    {#- -#} +
    {#- -#}
    {%- if krate.documented_items and krate.total_items -%} - {% set percent = krate.documented_items * 100 / krate.total_items %} -
    -
    - -
    + {%- set percent = krate.documented_items * 100 / krate.total_items -%} +
    {#- -#} +
    {#- -#} + {#- -#} +
    {#- -#}
    {%- endif -%} -
    +
    {#- -#} {%- else -%} -
  • +
  • {#- -#} - {{ "cube" | fas }} - {{ metadata.name }}-{{ metadata.version }} - + {{- "cube" | fas }} {# -#} + {{ metadata.name }}-{{ metadata.version }} {#- -#} + {#- -#}
    • {%- endif -%}{# If this is the latest release and it's been yanked, just display a warning #} {%- if is_latest_version and metadata.yanked -%} -
  • - - {{ "triangle-exclamation" | fas }} - This release has been yanked - +
  • {#- -#} + {#- -#} + {{- "triangle-exclamation" | fas -}} {# -#} + This release has been yanked {#- -#} + {#- -#}
    • {# - If this isn't the most recent stable release, offer a link to the latest #} + If this isn't the most recent stable release, offer a link to the latest -#} {%- elif not is_latest_version -%} {%- if metadata.yanked -%} {%- set tooltip = "You are seeing a yanked version of the " ~ metadata.name ~ " crate. Click here to go to the latest version." -%} @@ -189,40 +189,42 @@ {%- set title = "Go to latest version" -%} {%- endif -%} -
  • - {#- -#} + - {{ "triangle-exclamation" | fas }} - {{ title }} - + {{- "triangle-exclamation" | fas -}} {# -#} + {{ title }} {#- -#} + {#- -#}
    • {%- endif -%} - {# Display the platforms that the release has been built for #} + {#- Display the platforms that the release has been built for -#} {%- if metadata.doc_targets -%} -
  • +
  • {#- -#} - {{ "gears" | fas }} - Platform - + {{- "gears" | fas -}} + Platform {#- -#} + {#- -#} - {# Build the dropdown list showing available targets #} + {#- Build the dropdown list showing available targets -#} -
    • {# - Display the features available in current build - #}
  • - - {{ "flag" | fas }} - Feature flags - + {#- -#}
    • - {% endif %} + {#- Display the features available in current build -#} +
  • {#- -#} + + {{- "flag" | fas -}} {# -#} + Feature flags {#- -#} + {#- -#} +
    • + {%- endif -%} {%- include "header/topbar_end.html" -%} diff --git a/templates/rustdoc/vendored.html b/templates/rustdoc/vendored.html index a3d5d7e5f..e64bea9a9 100644 --- a/templates/rustdoc/vendored.html +++ b/templates/rustdoc/vendored.html @@ -1,2 +1,2 @@ - +{#- -#} \ No newline at end of file