https://github.com/juliadocs/documentertools.jl
Extra tools for setting up Documenter
https://github.com/juliadocs/documentertools.jl
documentation documentation-generator julia
Last synced: 26 days ago
JSON representation
Extra tools for setting up Documenter
- Host: GitHub
- URL: https://github.com/juliadocs/documentertools.jl
- Owner: JuliaDocs
- License: other
- Created: 2018-08-10T15:41:13.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-13T20:59:31.000Z (about 1 year ago)
- Last Synced: 2024-05-01T15:38:11.724Z (about 1 year ago)
- Topics: documentation, documentation-generator, julia
- Language: Julia
- Homepage:
- Size: 99.6 KB
- Stars: 30
- Watchers: 6
- Forks: 20
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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