read-doc 0.1.0

Macro to read module documentation from Rust source files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
#
# When uploading crates to the registry Cargo will automatically
# "normalize" Cargo.toml files for maximal compatibility
# with all versions of Cargo and also rewrite `path` dependencies
# to registry (e.g., crates.io) dependencies.
#
# If you are reading this file be aware that the original Cargo.toml
# will likely look very different (and much more reasonable).
# See Cargo.toml.orig for the original contents.

[package]
edition = "2024"
rust-version = "1.88"
name = "read-doc"
version = "0.1.0"
authors = ["Daniel Parks <oss-read-doc@demonhorse.org>"]
build = false
exclude = [
    ".*",
    "/release.sh",
]
autolib = false
autobins = false
autoexamples = false
autotests = false
autobenches = false
description = "Macro to read module documentation from Rust source files"
homepage = "https://github.com/danielparks/read-doc"
readme = "README.md"
keywords = []
categories = []
license = "MIT OR Apache-2.0"
repository = "https://github.com/danielparks/read-doc"

[package.metadata.docs.rs]
all-features = true
rustdoc-args = [
    "--cfg",
    "docsrs",
]

[lib]
name = "read_doc"
path = "src/lib.rs"
proc-macro = true

[[test]]
name = "compile_errors"
path = "tests/compile_errors.rs"

[[test]]
name = "compiles"
path = "tests/compiles.rs"

[[test]]
name = "output"
path = "tests/output.rs"

[dependencies.proc-macro2]
version = "1.0.106"
features = ["span-locations"]

[dependencies.quote]
version = "1.0.44"

[dependencies.syn]
version = "2.0.114"
features = [
    "full",
    "parsing",
]

[dev-dependencies.assert2]
version = "0.3.16"

[dev-dependencies.trybuild]
version = "1.0.114"

[lints.clippy]
allow_attributes = "warn"
allow_attributes_without_reason = "warn"
arithmetic_side_effects = "warn"
as_underscore = "warn"
assertions_on_result_states = "warn"
dbg_macro = "warn"
default_union_representation = "warn"
empty_structs_with_brackets = "warn"
filetype_is_file = "warn"
fn_to_numeric_cast_any = "warn"
format_push_string = "warn"
get_unwrap = "warn"
impl_trait_in_params = "warn"
integer_division = "warn"
let_underscore_untyped = "allow"
lossy_float_literal = "warn"
manual_string_new = "allow"
map_unwrap_or = "allow"
mem_forget = "warn"
missing_docs_in_private_items = "warn"
mixed_read_write_in_expression = "warn"
module_name_repetitions = "allow"
multiple_inherent_impl = "warn"
multiple_unsafe_ops_per_block = "warn"
mutex_atomic = "warn"
option_if_let_else = "allow"
rc_buffer = "warn"
rc_mutex = "warn"
same_name_method = "warn"
semicolon_inside_block = "warn"
str_to_string = "warn"
undocumented_unsafe_blocks = "warn"
unnecessary_debug_formatting = "allow"
unnecessary_safety_doc = "warn"
unnecessary_self_imports = "warn"
unneeded_field_pattern = "warn"
verbose_file_reads = "warn"

[lints.clippy.nursery]
level = "warn"
priority = -1

[lints.clippy.pedantic]
level = "warn"
priority = -1

[lints.rust]
missing_docs = "warn"
unsafe_code = "forbid"