Change recommended way to build docs

Former-commit-id: a4ad44fae9

.cargo/config.toml

@@ -0,0 +1,12 @@
+[alias]
+# We pass "--cfg docsrs" when building docs to turn on nightly-only rustdoc features like
+# `This is supported on feature="..." only.`
+#
+# "--cfg dep_docsrs" is used for the same reason, but for `teloxide-core`.
+docs = """
+doc 
+  --all-features 
+  --config build.rustflags=["--cfg=dep_docsrs"]
+  --config build.rustdocflags=["--cfg=docsrs","-Znormalize-docs"]
+  -Zrustdoc-scrape-examples=examples
+"""

src/lib.rs

@@ -44,15 +44,11 @@
     html_logo_url = "https://github.com/teloxide/teloxide/raw/master/ICON.png",
     html_favicon_url = "https://github.com/teloxide/teloxide/raw/master/ICON.png"
 )]
-// We pass "--cfg docsrs" when building docs to add `This is supported on
-// feature="..." only.`
-//
-// "--cfg dep_docsrs" is used for the same reason, but for `teloxide-core`.
-//
 // To properly build docs of this crate run
 // ```console
-// $ RUSTFLAGS="--cfg dep_docsrs" RUSTDOCFLAGS="--cfg docsrs -Znormalize-docs" cargo +nightly doc --open --all-features
+// $ cargo docs --open
 // ```
+// (docs is an alias from `.cargo/config.toml`)
 #![cfg_attr(all(docsrs, feature = "nightly"), feature(doc_cfg, doc_auto_cfg))]
 #![forbid(unsafe_code)]
 #![warn(rustdoc::broken_intra_doc_links)]