JuliaDocs / Documenter.jl
Licence: other
A documentation generator for Julia.
Stars: ✭ 384
Programming Languages
julia
2034 projects
Projects that are alternatives of or similar to Documenter.jl
NextBook
NextBook is quick and easy way to build technical books or documentation with markdown that run blazingly fast.
Stars: ✭ 153 (-60.16%)
Mutual labels: documentation-tool, documentation-generator
live-documenter
.NET documentation generator and live reader. Generate documentation from .NET code and xml comments, fast, quick and easy.
Stars: ✭ 64 (-83.33%)
Mutual labels: documentation-tool, documentation-generator
cutedoc
Generate stunning documentation for any project using simple markdown files.
Stars: ✭ 16 (-95.83%)
Mutual labels: documentation-tool, documentation-generator
Pydoc Markdown
Create Python API documentation in Markdown format.
Stars: ✭ 273 (-28.91%)
Mutual labels: documentation-tool, documentation-generator
tygen
Modern documentation generator for TypeScript built with ReactJS
Stars: ✭ 23 (-94.01%)
Mutual labels: documentation-tool, documentation-generator
numpydoc.el
Insert NumPy style docstrings in Python functions.
Stars: ✭ 33 (-91.41%)
Mutual labels: documentation-tool, documentation-generator
ank
ΛNK: Compile time docs verification and evaluation for Kotlin and Java (Temporarily moved to Arrow-kt)
Stars: ✭ 52 (-86.46%)
Mutual labels: documentation-tool, documentation-generator
Nbdev
Create delightful python projects using Jupyter Notebooks
Stars: ✭ 3,061 (+697.14%)
Mutual labels: documentation-tool, documentation-generator
Sourcedocs
Generate Markdown documentation from source code
Stars: ✭ 286 (-25.52%)
Mutual labels: documentation-tool, documentation-generator
badge-generator
Magically generate Markdown badges for your docs 🛡️ 🦡 🧙
Stars: ✭ 104 (-72.92%)
Mutual labels: documentation-tool, documentation-generator
Literate.jl
Simple package for literate programming in Julia
Stars: ✭ 272 (-29.17%)
Mutual labels: documentation-tool, documentation-generator
literator
📝 Generate literate-style markdown docs from your sources
Stars: ✭ 55 (-85.68%)
Mutual labels: documentation-tool, documentation-generator
BooGi
Generate GitBook-like modern docs/tutorial websites using Gatsby
Stars: ✭ 117 (-69.53%)
Mutual labels: documentation-tool, documentation-generator
Doxyrest
A compiler from Doxygen XML to reStructuredText -- hence, the name. It parses XML databases generated by Doxygen and produces reStructuredText for the Python documentation generator Sphinx.
Stars: ✭ 265 (-30.99%)
Mutual labels: documentation-tool, documentation-generator
strictdoc
Software for writing technical requirements specifications.
Stars: ✭ 80 (-79.17%)
Mutual labels: documentation-tool, documentation-generator
ocular
A documentation generator for our OSS frameworks
Stars: ✭ 42 (-89.06%)
Mutual labels: documentation-tool, documentation-generator
Dart
DART is a test documentation tool created by the Lockheed Martin Red Team to document and report on penetration tests, especially in isolated network environments.
Stars: ✭ 207 (-46.09%)
Mutual labels: documentation-tool, documentation-generator
Ford
Automatically generates FORtran Documentation from comments within the code.
Stars: ✭ 245 (-36.2%)
Mutual labels: documentation-tool, documentation-generator
newdoc
The newdoc tool generates files formatted with AsciiDoc, which are used in Red Hat documentation.
Stars: ✭ 14 (-96.35%)
Mutual labels: documentation-tool, documentation-generator
presidium
Presidium user documentation
Stars: ✭ 25 (-93.49%)
Mutual labels: documentation-tool, documentation-generator
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
- STABLE — documentation of the most recently tagged version.
- DEVEL — documentation of the in-development version.
Project Status
The package is tested against, and being developed for, Julia 1.0 and above on Linux, macOS, and Windows.
Support for Julia 0.4, 0.5, 0.6 and 0.7 has been dropped in the latest version, but older versions of Documenter may still work (Documenter versions 0.8, 0.11, 0.19, and 0.22 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.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].