diff --git a/Cargo.toml b/Cargo.toml index ffa01d7f23..25d82a6bbb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,7 +8,7 @@ exclude = ["examples/*", "book/*"] keywords = ["game", "engine", "sdk", "amethyst"] categories = ["game-engines"] -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst" +documentation = "https://docs-src.amethyst.rs/stable/amethyst" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_animation/Cargo.toml b/amethyst_animation/Cargo.toml index 5caabd08a3..fe5781cf42 100644 --- a/amethyst_animation/Cargo.toml +++ b/amethyst_animation/Cargo.toml @@ -6,7 +6,7 @@ edition = "2018" description = "Animation support for Amethyst" keywords = ["game", "engine", "animation", "3d", "amethyst"] -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_animation/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_animation/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_assets/Cargo.toml b/amethyst_assets/Cargo.toml index f8bac2bdf2..163708eda1 100644 --- a/amethyst_assets/Cargo.toml +++ b/amethyst_assets/Cargo.toml @@ -12,7 +12,7 @@ license = "MIT/Apache-2.0" keywords = ["game", "asset", "resource", "management", "amethyst"] categories = ["filesystem"] -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_assets/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_audio/Cargo.toml b/amethyst_audio/Cargo.toml index 2c5203b8bf..e9d9fa4156 100644 --- a/amethyst_audio/Cargo.toml +++ b/amethyst_audio/Cargo.toml @@ -8,7 +8,7 @@ exclude = ["examples/*"] keywords = ["game", "engine", "audio","amethyst"] categories = ["audio"] -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_audio/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_audio/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_config/Cargo.toml b/amethyst_config/Cargo.toml index 4dc8b58bb3..545065b04e 100644 --- a/amethyst_config/Cargo.toml +++ b/amethyst_config/Cargo.toml @@ -6,7 +6,7 @@ edition = "2018" description = "Loading from .ron files into Rust structures with defaults to prevent hard errors." exclude = ["examples/*"] -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_config/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_config/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_controls/Cargo.toml b/amethyst_controls/Cargo.toml index 9d3cd60c3b..aaa65ae3d2 100644 --- a/amethyst_controls/Cargo.toml +++ b/amethyst_controls/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Joël Lupien "] edition = "2018" description = "Amethyst controls" -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_controls/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_controls/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_core/Cargo.toml b/amethyst_core/Cargo.toml index 3dedcf06a4..5903fd73b7 100644 --- a/amethyst_core/Cargo.toml +++ b/amethyst_core/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Simon Rönnberg "] edition = "2018" description = "Amethyst core" -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_core/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_core/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_derive/Cargo.toml b/amethyst_derive/Cargo.toml index 69170b8d7d..ba60a7e528 100644 --- a/amethyst_derive/Cargo.toml +++ b/amethyst_derive/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Simon Rönnberg "] edition = "2018" description = "Amethyst derive" -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_derive/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_derive/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_error/Cargo.toml b/amethyst_error/Cargo.toml index 59e2825522..be46ac0ea9 100644 --- a/amethyst_error/Cargo.toml +++ b/amethyst_error/Cargo.toml @@ -10,7 +10,7 @@ Internal error handling for Amethyst. keywords = ["game", "error", "amethyst"] categories = ["error"] -documentation = "https://www.amethyst.rs/doc/master/doc/amethyst/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_error/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_gltf/Cargo.toml b/amethyst_gltf/Cargo.toml index 50e1647d64..e6e38dd587 100644 --- a/amethyst_gltf/Cargo.toml +++ b/amethyst_gltf/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Rhuagh "] edition = "2018" description = "GLTF asset loading" -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_gltf/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_gltf/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_input/Cargo.toml b/amethyst_input/Cargo.toml index 915e698195..fc8f4c64ce 100644 --- a/amethyst_input/Cargo.toml +++ b/amethyst_input/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Rhuagh ", "Xaeroxe "] edition = "2018" description = "Input rebinding " -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_input/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_input/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_locale/Cargo.toml b/amethyst_locale/Cargo.toml index cc12732dd2..26df5c4b69 100644 --- a/amethyst_locale/Cargo.toml +++ b/amethyst_locale/Cargo.toml @@ -12,7 +12,7 @@ license = "MIT/Apache-2.0" keywords = ["game", "localisation", "resource", "management", "amethyst"] categories = ["filesystem,localisation"] -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_locale/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_locale/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_network/Cargo.toml b/amethyst_network/Cargo.toml index 2f02e28e8b..fc27ae78f4 100644 --- a/amethyst_network/Cargo.toml +++ b/amethyst_network/Cargo.toml @@ -11,7 +11,7 @@ keywords = ["networking", "specs", "ecs", "amethyst", "serialization"] categories = ["game-engines"] readme = "README.md" -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_network/index.html" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_network/index.html" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" license = "MIT/Apache-2.0" diff --git a/amethyst_renderer/Cargo.toml b/amethyst_renderer/Cargo.toml index a92466036b..43bb01e935 100644 --- a/amethyst_renderer/Cargo.toml +++ b/amethyst_renderer/Cargo.toml @@ -8,7 +8,7 @@ exclude = ["examples/*"] keywords = ["game", "engine", "renderer", "3d", "amethyst"] categories = ["rendering", "rendering::engine"] -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_renderer/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" diff --git a/amethyst_test/Cargo.toml b/amethyst_test/Cargo.toml index 98eab74ac3..dae9e7f23c 100644 --- a/amethyst_test/Cargo.toml +++ b/amethyst_test/Cargo.toml @@ -7,7 +7,7 @@ description = "Amethyst test utilities crate" keywords = ["test", "amethyst"] categories = ["game-engines"] -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_test/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_test/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" license = "MIT/Apache-2.0" diff --git a/amethyst_ui/Cargo.toml b/amethyst_ui/Cargo.toml index 9e0a674129..c02c144795 100644 --- a/amethyst_ui/Cargo.toml +++ b/amethyst_ui/Cargo.toml @@ -7,7 +7,7 @@ description = "Amethyst UI crate" keywords = ["ui", "specs", "ecs", "amethyst"] categories = ["game-engines"] -documentation = "https://www.amethyst.rs/doc/latest/doc/amethyst_ui/" +documentation = "https://docs-src.amethyst.rs/stable/amethyst_ui/" homepage = "https://www.amethyst.rs/" repository = "https://github.com/amethyst/amethyst" license = "MIT/Apache-2.0" diff --git a/amethyst_utils/Cargo.toml b/amethyst_utils/Cargo.toml index fc0c031c6a..b76fd0f860 100644 --- a/amethyst_utils/Cargo.toml +++ b/amethyst_utils/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Simon Rönnberg ", "Joël Lupien **Note:** The code snippets in this section explain the parts of setting up sprite rendering separately. For complete application examples, please refer to the [*sprites_ordered*][ex_ordered] example in the [examples][ex_all] directory. -[doc_ss]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/struct.SpriteSheet.html -[doc_tex]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/struct.Texture.html +[doc_ss]: https://docs-src.amethyst.rs/stable/amethyst_renderer/struct.SpriteSheet.html +[doc_tex]: https://docs-src.amethyst.rs/stable/amethyst_renderer/struct.Texture.html [ex_all]: https://github.com/amethyst/amethyst/tree/master/examples [ex_ordered]: https://github.com/amethyst/amethyst/tree/master/examples/sprites_ordered diff --git a/book/src/sprites/display_the_texture.md b/book/src/sprites/display_the_texture.md index 36423f3f62..5535c2578c 100644 --- a/book/src/sprites/display_the_texture.md +++ b/book/src/sprites/display_the_texture.md @@ -55,8 +55,8 @@ impl SimpleState for ExampleState { } ``` -[doc_drawflat2d]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/struct.DrawFlat2D.html -[doc_tex_handle]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/type.TextureHandle.html -[doc_component]: https://www.amethyst.rs/doc/latest/doc/specs/trait.Component.html -[doc_handle]: https://www.amethyst.rs/doc/latest/doc/amethyst_assets/struct.Handle.html -[doc_flipped]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/struct.Flipped.html +[doc_drawflat2d]: https://docs-src.amethyst.rs/stable/amethyst_renderer/struct.DrawFlat2D.html +[doc_tex_handle]: https://docs-src.amethyst.rs/stable/amethyst_renderer/type.TextureHandle.html +[doc_component]: https://docs-src.amethyst.rs/stable/specs/trait.Component.html +[doc_handle]: https://docs-src.amethyst.rs/stable/amethyst_assets/struct.Handle.html +[doc_flipped]: https://docs-src.amethyst.rs/stable/amethyst_renderer/struct.Flipped.html diff --git a/book/src/sprites/load_the_texture.md b/book/src/sprites/load_the_texture.md index 24a0a0ae49..1d14aa4e8d 100644 --- a/book/src/sprites/load_the_texture.md +++ b/book/src/sprites/load_the_texture.md @@ -44,14 +44,14 @@ There is one thing that may surprise you. The loaded texture will use linear filter, e.g. screen pixels will be linearly interpolated between the closest image pixels. In layman's terms, if your images have small resolution, sprites will look blury. Use `TextureMetadata::srgb_scale()` instead to avoid such effect. Screen pixel will be taken from nearest pixel of texture in that case. -[doc_asset]: https://www.amethyst.rs/doc/latest/doc/amethyst_assets/trait.Asset.html -[doc_asset_get]: https://www.amethyst.rs/doc/latest/doc/amethyst_assets/struct.AssetStorage.html#method.get -[doc_fmt_bmp]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/struct.BmpFormat.html -[doc_fmt_jpg]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/struct.JpgFormat.html -[doc_fmt_png]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/struct.PngFormat.html -[doc_fmt_tga]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/struct.TgaFormat.html -[doc_load]: https://www.amethyst.rs/doc/latest/doc/amethyst_assets/struct.Loader.html#method.load -[doc_read_resource]: https://www.amethyst.rs/doc/latest/doc/specs/world/struct.World.html#method.read_resource -[doc_ss]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/struct.SpriteSheet.html -[doc_tex]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/struct.Texture.html -[doc_tex_hd]: https://www.amethyst.rs/doc/latest/doc/amethyst_renderer/type.TextureHandle.html +[doc_asset]: https://docs-src.amethyst.rs/stable/amethyst_assets/trait.Asset.html +[doc_asset_get]: https://docs-src.amethyst.rs/stable/amethyst_assets/struct.AssetStorage.html#method.get +[doc_fmt_bmp]: https://docs-src.amethyst.rs/stable/amethyst_renderer/struct.BmpFormat.html +[doc_fmt_jpg]: https://docs-src.amethyst.rs/stable/amethyst_renderer/struct.JpgFormat.html +[doc_fmt_png]: https://docs-src.amethyst.rs/stable/amethyst_renderer/struct.PngFormat.html +[doc_fmt_tga]: https://docs-src.amethyst.rs/stable/amethyst_renderer/struct.TgaFormat.html +[doc_load]: https://docs-src.amethyst.rs/stable/amethyst_assets/struct.Loader.html#method.load +[doc_read_resource]: https://docs-src.amethyst.rs/stable/specs/world/struct.World.html#method.read_resource +[doc_ss]: https://docs-src.amethyst.rs/stable/amethyst_renderer/struct.SpriteSheet.html +[doc_tex]: https://docs-src.amethyst.rs/stable/amethyst_renderer/struct.Texture.html +[doc_tex_hd]: https://docs-src.amethyst.rs/stable/amethyst_renderer/type.TextureHandle.html diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index ad737db125..7fb2162e84 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -206,7 +206,7 @@ There are two types of documentation in Amethyst you can work on: 1. [API documentation][ad] 2. [The Amethyst book][ab] -[ad]: https://www.amethyst.rs/doc/master/doc/amethyst/ +[ad]: https://docs-src.amethyst.rs/master/amethyst/ [ab]: https://book.amethyst.rs/master/ Our Rust API documentation is generated directly from source code comments