# DocumenterTools

| **Documentation**                       | **Build Status**                |
|:---------------------------------------:|:-------------------------------:|
| [![][docs-stable-img]][docs-stable-url] | [![][GHA-img]][GHA-url] [![][codecov-img]][codecov-url] [![PkgEval][pkgeval-img]][pkgeval-url] |

This package contains utilities for setting up documentation generation with
[Documenter.jl][documenter].

## Installation

The package can be added using the Julia package manager. From the Julia REPL, type `]` to
enter the Pkg REPL mode and run

```
pkg> add DocumenterTools
```

[documenter]: https://github.com/JuliaDocs/Documenter.jl

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://documenter.juliadocs.org/stable/lib/internals/documentertools/

[codecov-img]: https://codecov.io/gh/JuliaDocs/DocumenterTools.jl/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/JuliaDocs/DocumenterTools.jl

[pkgeval-img]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/D/DocumenterTools.svg
[pkgeval-url]: https://juliaci.github.io/NanosoldierReports/pkgeval_badges/D/DocumenterTools.html

[GHA-img]: https://github.com/JuliaDocs/DocumenterTools.jl/actions/workflows/CI.yml/badge.svg
[GHA-url]: https://github.com/JuliaDocs/DocumenterTools.jl/actions/workflows/CI.yml
