aboutsummaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
authorMartin Fischer <martin@push-f.com>2023-08-19 11:28:31 +0200
committerMartin Fischer <martin@push-f.com>2023-08-19 13:41:55 +0200
commita83e64e81de66ff40cc8a6293f0b5650d431689c (patch)
tree76914a4cc60c8b35287a5b57713b3b0206de7935 /src/lib.rs
parent9323efc3f862c5b071e808194982cbb6672f9919 (diff)
fix(docs): fix broken relative link in rustdoc
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index cbaf94d..c2a1019 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,6 +1,7 @@
#![warn(missing_docs)]
// This is an HTML parser. HTML can be untrusted input from the internet.
#![forbid(unsafe_code)]
+#![doc = concat!("[the LICENSE file]: ", file_url!("LICENSE"))]
#![doc = include_str!("../README.md")]
pub mod attr;
@@ -19,3 +20,16 @@ pub use utils::State as InternalState;
pub use emitter::{Comment, DefaultEmitter, Doctype, Emitter, EndTag, StartTag, Token};
pub use error::Error;
pub use tokenizer::{State, Tokenizer};
+
+/// Relative links in the README.md don't work in rustdoc, so we have to override them.
+macro_rules! file_url {
+ ($path:literal) => {
+ concat!(
+ env!("CARGO_PKG_REPOSITORY"),
+ "/tree/",
+ $path,
+ "?h=v",
+ env!("CARGO_PKG_VERSION")
+ )
+ };
+}