From e4b2509bb4a743b62e0e466e841d75d3c7567efb Mon Sep 17 00:00:00 2001 From: Nick Flueckiger Date: Sat, 13 Feb 2021 19:37:03 +0100 Subject: [PATCH 1/5] Add left and right margin to center about container --- templates/core/about/badges.html | 91 +++++------ templates/core/about/builds.html | 212 +++++++++++++------------ templates/core/about/index.html | 75 ++++----- templates/core/about/metadata.html | 16 +- templates/core/about/redirections.html | 101 ++++++------ 5 files changed, 251 insertions(+), 244 deletions(-) diff --git a/templates/core/about/badges.html b/templates/core/about/badges.html index f2f6d24f0..b86519100 100644 --- a/templates/core/about/badges.html +++ b/templates/core/about/badges.html @@ -4,50 +4,51 @@ {%- block body -%}

Badges

- -
-

- You can use badges to show state of your documentation to your users. - The default badge will be pointed at the latest version of a crate. - You can use version parameter to show status of documentation for - any version you want. -

- -

- Badge will display in blue if docs.rs is successfully hosting your crate - documentation, and red if building documentation failing. -

- -

Example badges for mio crate:

- - - - - - - - - - {%- set mio_badge = "https://docs.rs/mio/badge.svg" -%} - - - - - - - - - - - - - - - -
URLBadge
Latest version: {{ mio_badge }}mio
- Version 0.4.4: {{ mio_badge }}?version=0.4.4 - mio
- Version 0.1.0: {{ mio_badge }}?version=0.1.0 - mio
+
+
+

+ You can use badges to show state of your documentation to your users. + The default badge will be pointed at the latest version of a crate. + You can use version parameter to show status of documentation for + any version you want. +

+ +

+ Badge will display in blue if docs.rs is successfully hosting your crate + documentation, and red if building documentation failing. +

+ +

Example badges for the mio crate:

+ + + + + + + + + + {%- set mio_badge = "https://docs.rs/mio/badge.svg" -%} + + + + + + + + + + + + + + + +
URLBadge
Latest version: {{ mio_badge }}mio
+ Version 0.4.4: {{ mio_badge }}?version=0.4.4 + mio
+ Version 0.1.0: {{ mio_badge }}?version=0.1.0 + mio
+
{%- endblock body %} diff --git a/templates/core/about/builds.html b/templates/core/about/builds.html index 326c7bfcd..3f686d71a 100644 --- a/templates/core/about/builds.html +++ b/templates/core/about/builds.html @@ -5,111 +5,113 @@ {%- 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 %} - The current version in use is {{ rustc_version }}. - {%- endif -%} -

- -

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. -

- -

Detecting Docs.rs

-

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

-            
-                if let Ok(_) = std::env::var("DOCS_RS") {
-                    // ... your code here ...
-                }
-            
-
- {%- 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. -

- -

- You can configure how your crate is built by adding package metadata to your Cargo.toml, e.g.: - {% filter dedent -%} - 

-            
-                [package.metadata.docs.rs]
-                rustc-args = ["--cfg", "docsrs"]
-            
-
- {%- 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: -

- - {{ 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. -

- +
+
+

+ 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

+ +

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 dedent(levels=4) -%} + 

+                
+                    if let Ok(_) = std::env::var("DOCS_RS") {
+                        // ... your code here ...
+                    }
+                
+
+ {%- 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. +

+ +

+ You can configure how your crate is built by adding package metadata to your Cargo.toml, e.g.: + {% filter dedent -%} + 

+                
+                    [package.metadata.docs.rs]
+                    rustc-args = ["--cfg", "docsrs"]
+                
+
+ {%- 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: +

+ + {{ 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 %} diff --git a/templates/core/about/index.html b/templates/core/about/index.html index bc8dfeab5..5ed30c345 100644 --- a/templates/core/about/index.html +++ b/templates/core/about/index.html @@ -6,42 +6,43 @@ {%- 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() }}

- -

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 #docs-rs on Discord. -

- +
+
+

+ 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() }}

+ +

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 #docs-rs on Discord. +

+
{%- endblock body %} diff --git a/templates/core/about/metadata.html b/templates/core/about/metadata.html index e50f3a812..f631ad96d 100644 --- a/templates/core/about/metadata.html +++ b/templates/core/about/metadata.html @@ -5,15 +5,17 @@ {%- block body -%}

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:

- 
{%- include "core/Cargo.toml.example" -%}
+ 
{%- include "core/Cargo.toml.example" -%}
+
{%- endblock body %} diff --git a/templates/core/about/redirections.html b/templates/core/about/redirections.html index 94226adc7..17caba1a6 100644 --- a/templates/core/about/redirections.html +++ b/templates/core/about/redirections.html @@ -4,61 +4,62 @@ {%- block body -%}

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/*/clap/struct.App.html - - Latest version of this page (if it still exists). "latest" or "newest" work as well as - *. -
+ + + docs.rs/clap/*/clap/struct.App.html + + + Latest version of this page (if it still exists). "latest" or "newest" work as well as + *. + + + + +
{%- endblock body %} From 8846382e5cfcc63d707af4ae3cf15a91a2e60196 Mon Sep 17 00:00:00 2001 From: Nick Flueckiger Date: Sat, 13 Feb 2021 23:03:17 +0100 Subject: [PATCH 2/5] Add spacing to bottom of page where needed --- templates/core/about/builds.html | 1 + templates/core/about/redirections.html | 1 + 2 files changed, 2 insertions(+) diff --git a/templates/core/about/builds.html b/templates/core/about/builds.html index 3f686d71a..4e00f4c2b 100644 --- a/templates/core/about/builds.html +++ b/templates/core/about/builds.html @@ -112,6 +112,7 @@

Other failures

+
{%- endblock body %} diff --git a/templates/core/about/redirections.html b/templates/core/about/redirections.html index 17caba1a6..845674a2f 100644 --- a/templates/core/about/redirections.html +++ b/templates/core/about/redirections.html @@ -61,5 +61,6 @@

Shorthand URLs

+
{%- endblock body %} From 87dae44a0f301247124e1506b62a3c78a6143fb1 Mon Sep 17 00:00:00 2001 From: Nick Flueckiger Date: Sun, 14 Feb 2021 00:07:14 +0100 Subject: [PATCH 3/5] Remove wrong class name --- templates/core/about/badges.html | 2 +- templates/core/about/builds.html | 2 +- templates/core/about/index.html | 2 +- templates/core/about/metadata.html | 2 +- templates/core/about/redirections.html | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/templates/core/about/badges.html b/templates/core/about/badges.html index b86519100..3043c0ca5 100644 --- a/templates/core/about/badges.html +++ b/templates/core/about/badges.html @@ -4,7 +4,7 @@ {%- block body -%}

Badges

-
+

You can use badges to show state of your documentation to your users. diff --git a/templates/core/about/builds.html b/templates/core/about/builds.html index 4e00f4c2b..f12cda491 100644 --- a/templates/core/about/builds.html +++ b/templates/core/about/builds.html @@ -5,7 +5,7 @@ {%- block body -%} {%- set docsrs_repo = "https://github.com/rust-lang/docs.rs" -%}

Builds

-
+

Docs.rs automatically builds documentation for crates released on crates.io. diff --git a/templates/core/about/index.html b/templates/core/about/index.html index 5ed30c345..f36bb13a4 100644 --- a/templates/core/about/index.html +++ b/templates/core/about/index.html @@ -6,7 +6,7 @@ {%- set docsrs_repo = "https://github.com/rust-lang/docs.rs" -%}

About Docs.rs

-
+

Docs.rs is an diff --git a/templates/core/about/metadata.html b/templates/core/about/metadata.html index f631ad96d..73edcd4ef 100644 --- a/templates/core/about/metadata.html +++ b/templates/core/about/metadata.html @@ -5,7 +5,7 @@ {%- block body -%}

Metadata for custom builds

-
+

You can customize docs.rs builds by defining [package.metadata.docs.rs] diff --git a/templates/core/about/redirections.html b/templates/core/about/redirections.html index 845674a2f..cc34fe024 100644 --- a/templates/core/about/redirections.html +++ b/templates/core/about/redirections.html @@ -4,7 +4,7 @@ {%- block body -%}

Shorthand URLs

-
+

Docs.rs uses semver to parse URLs. You can use this feature to access From 6bcfe461eec7de6b43493f738445ad9615921347 Mon Sep 17 00:00:00 2001 From: Nick Flueckiger Date: Sun, 14 Feb 2021 11:31:19 +0100 Subject: [PATCH 4/5] Revert indentation --- templates/core/about/badges.html | 80 ++++----- templates/core/about/builds.html | 214 ++++++++++++------------- templates/core/about/index.html | 74 ++++----- templates/core/about/metadata.html | 18 +-- templates/core/about/redirections.html | 103 ++++++------ 5 files changed, 245 insertions(+), 244 deletions(-) diff --git a/templates/core/about/badges.html b/templates/core/about/badges.html index 3043c0ca5..ff218398d 100644 --- a/templates/core/about/badges.html +++ b/templates/core/about/badges.html @@ -5,50 +5,50 @@ {%- block body -%}

Badges

-
-

- You can use badges to show state of your documentation to your users. - The default badge will be pointed at the latest version of a crate. - You can use version parameter to show status of documentation for - any version you want. -

+
+

+ You can use badges to show state of your documentation to your users. + The default badge will be pointed at the latest version of a crate. + You can use version parameter to show status of documentation for + any version you want. +

-

- Badge will display in blue if docs.rs is successfully hosting your crate - documentation, and red if building documentation failing. -

+

+ Badge will display in blue if docs.rs is successfully hosting your crate + documentation, and red if building documentation failing. +

-

Example badges for the mio crate:

- - - - - - - +

Example badges for the mio crate:

+
URLBadge
+ + + + + + - - {%- set mio_badge = "https://docs.rs/mio/badge.svg" -%} - - - - + + {%- set mio_badge = "https://docs.rs/mio/badge.svg" -%} + + + + - - - - + + + + - - - - - -
URLBadge
Latest version: {{ mio_badge }}mio
Latest version: {{ mio_badge }}mio
- Version 0.4.4: {{ mio_badge }}?version=0.4.4 - mio
+ Version 0.4.4: {{ mio_badge }}?version=0.4.4 + mio
- Version 0.1.0: {{ mio_badge }}?version=0.1.0 - mio
-
+ + + Version 0.1.0: {{ mio_badge }}?version=0.1.0 + + mio + + + +
{%- endblock body %} diff --git a/templates/core/about/builds.html b/templates/core/about/builds.html index f12cda491..46c2fc5df 100644 --- a/templates/core/about/builds.html +++ b/templates/core/about/builds.html @@ -6,113 +6,113 @@ {%- 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 %} - The current version in use is {{ rustc_version }}. - {%- endif -%} -

- -

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. -

- -

Detecting Docs.rs

-

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

-                
-                    if let Ok(_) = std::env::var("DOCS_RS") {
-                        // ... your code here ...
-                    }
-                
-
- {%- 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. -

- -

- You can configure how your crate is built by adding package metadata to your Cargo.toml, e.g.: - {% filter dedent -%} - 

-                
-                    [package.metadata.docs.rs]
-                    rustc-args = ["--cfg", "docsrs"]
-                
-
- {%- 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: -

- - {{ 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. -

- -
-
+
+

+ 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

+ +

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 dedent(levels=4) -%} + 

+            
+                if let Ok(_) = std::env::var("DOCS_RS") {
+                    // ... your code here ...
+                }
+            
+
+ {%- 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. +

+ +

+ You can configure how your crate is built by adding package metadata to your Cargo.toml, e.g.: + {% filter dedent -%} + 

+            
+                [package.metadata.docs.rs]
+                rustc-args = ["--cfg", "docsrs"]
+            
+
+ {%- 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: +

+ + {{ 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 %} diff --git a/templates/core/about/index.html b/templates/core/about/index.html index f36bb13a4..342913ce5 100644 --- a/templates/core/about/index.html +++ b/templates/core/about/index.html @@ -7,42 +7,42 @@

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() }}

- -

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 #docs-rs on Discord. -

-
+
+

+ 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() }}

+ +

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 #docs-rs on Discord. +

+
{%- endblock body %} diff --git a/templates/core/about/metadata.html b/templates/core/about/metadata.html index 73edcd4ef..862ed18dd 100644 --- a/templates/core/about/metadata.html +++ b/templates/core/about/metadata.html @@ -6,17 +6,17 @@

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:

- 
{%- include "core/Cargo.toml.example" -%}
-
-
+ 
{%- include "core/Cargo.toml.example" -%}
+
+
{%- endblock body %} {% block css -%} diff --git a/templates/core/about/redirections.html b/templates/core/about/redirections.html index cc34fe024..cbff53403 100644 --- a/templates/core/about/redirections.html +++ b/templates/core/about/redirections.html @@ -4,63 +4,64 @@ {%- block body -%}

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/*/clap/struct.App.html - - Latest version of this page (if it still exists). "latest" or "newest" work as well as - *. -
-
-
+ + + docs.rs/clap/*/clap/struct.App.html + + + Latest version of this page (if it still exists). "latest" or "newest" work as well as + *. + + + + +
+
{%- endblock body %} From eca4ecb12d08c4bb688bc8057b412e3c200a70db Mon Sep 17 00:00:00 2001 From: Nick Flueckiger Date: Sun, 14 Feb 2021 12:08:37 +0100 Subject: [PATCH 5/5] Remove unneeded changes --- templates/core/about/badges.html | 1 + templates/core/about/index.html | 1 + templates/core/about/metadata.html | 20 ++++++++++---------- 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/templates/core/about/badges.html b/templates/core/about/badges.html index ff218398d..5cf5e5720 100644 --- a/templates/core/about/badges.html +++ b/templates/core/about/badges.html @@ -4,6 +4,7 @@ {%- block body -%}

Badges

+

diff --git a/templates/core/about/index.html b/templates/core/about/index.html index 342913ce5..b3c7f4e2a 100644 --- a/templates/core/about/index.html +++ b/templates/core/about/index.html @@ -43,6 +43,7 @@

Contact

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

+
{%- endblock body %} diff --git a/templates/core/about/metadata.html b/templates/core/about/metadata.html index 862ed18dd..fe4fc8b3f 100644 --- a/templates/core/about/metadata.html +++ b/templates/core/about/metadata.html @@ -5,18 +5,18 @@ {%- block body -%}

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:

- 
{%- include "core/Cargo.toml.example" -%}
-
-
+ 
{%- include "core/Cargo.toml.example" -%}
+
+
{%- endblock body %} {% block css -%}