Skip to content

Latest commit

 

History

History
57 lines (34 loc) · 2.71 KB

README.md

File metadata and controls

57 lines (34 loc) · 2.71 KB

Documenter

A documentation generator for Julia.

Documentation Build Status

Installation

The package can be installed with Julias package manager:

julia> import Pkg

julia> Pkg.add("Documenter")

Documentation

  • STABLEmost recently tagged version of the documentation.
  • LATESTin-development version of the documentation.

Project Status

The package is tested against Julia 0.7, 1.0 and current 1.1-dev on Linux, OS X, 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 with those Julia versions (the 0.8, 0.11 and 0.19 branches for Julia versions 0.4, 0.5 and 0.6, respectively).

Questions and Contributions

Usage questions can be posted on the Julia Discourse forum under the documenter tag, 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.