A documentation generator for Julia.

README.md

Documenter

A documentation generator for Julia.

Documentation Build Status

Installation

The package can be installed with the Julia package manager. From the Julia REPL, type ] to enter the Pkg REPL mode and run:

pkg> add Documenter

Or, equivalently, via the Pkg API:

julia> import Pkg; Pkg.add("Documenter")

Documentation

  • STABLEdocumentation of the most recently tagged version.
  • DEVELdocumentation of the in-development version.

Project Status

The package is tested against Julia 0.7, 1.0 and the nightly builds of the Julia master branch on Linux, macOS, and Windows.

Support for Julia 0.4, 0.5 and 0.6 has been dropped in the latest version, but older versions of Documenter may still work (Documenter versions 0.8, 0.11 and 0.19, respectively).

Questions and Contributions

Usage questions can be posted on the Julia Discourse forum under the documenter tag, in the #documentation channel of the Julia Slack and/or in the JuliaDocs Gitter chat room.

Contributions are very welcome, as are feature requests and suggestions. Please open an issue if you encounter any problems. The contributing page has a few guidelines that should be followed when opening pull requests and contributing code.