dep_doc 0.1.0

Add a cute dependency declaration snippet in your crate documentation
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

# `dep_doc`

Add a cute dependency declaration snippet in your crate documentation.

## Adding to `Cargo.toml`

```TOML
[dependencies]
dep_doc = "0.1.0"
```

## Goal

When writing Rust libraries, it is quite common to add a code snippet
which shows to the end-user how to add the crate to the `Cargo.toml`. The
problem is that there's no way to ensure that the crate name and version
are correct before releasing a new version.

This crate aims to automate the TOML snippet generation by providing
macro-assisted solution which expand in the correct crate name and version.
It does so by reading environment variables that are set by cargo itself.

## Usage

To add the TOML snippet, insert the following line between two documentation
lines:

```rust
//! Some doc...
#![doc = dep_doc::dep_doc!()]
//! Some other doc
```

If invoked in `dep_doc`, this will generates the following documentation:

> Some doc...
> ```TOML
> [dependencies]
> dep_doc = "0.1.0"
> ```
> Some other doc

## Customization

Some crates may document specific features, git repository, branches,
commit hash, and so on. This can be addressed by passing code in the
`dep_doc` invocation:

```rust
//! Some doc...
#![doc = dep_doc::dep_doc!(git = "https://github.com/scrabsha/dep-doc")]
//! Some other doc
```

If invoked in `dep_doc`, this will generate the following documentation:

> Some doc...
> ```TOML
> [dependencies]
> dep_doc = { version = "0.1.0", git = "https://github.com/scrabsha/dep-doc" }
> ```
> Some other doc

## My library is better suited as a development dependency

That's fine! `dev_dep_doc` generates the appropriate documentation. It
replaces the `[dependencies]` section by a `[dev-dependencies]` one.

```rust
//! Some doc...
#![doc = dep_doc::dev_dep_doc!(features = ["proc_macro", "no_std"])]
//! Some other doc
```

If invoked in `dep_doc`, this will generate the following documentation:

> Some doc...
> ```TOML
> [dev-dependencies]
> dep_doc = { version = "0.1.0", features = ["prod_macro", "no_std"] }
> ```
> Some other doc


<br>

#### License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br>

<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
</sub>