Revision 0eb7be2d955522983be8fdc486625d53be2b5787 authored by Jameson Nash on 07 August 2018, 16:22:34 UTC, committed by Keno Fischer on 08 August 2018, 13:20:43 UTC
1 parent 239f903
README.md
# Julia Documentation README
Julia's documentation is written in Markdown. A reference of all supported syntax can be found in the [manual](https://docs.julialang.org/en/latest/manual/documentation/#markdown-syntax). All documentation can be found in the Markdown files in `doc/src/` and the docstrings in Julia source files in `base/`.
## Requirements
This documentation is built using the [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) package.
All dependencies are automatically installed into a sandboxed package directory in `doc/deps/` to avoid interfering with user-installed packages.
## Building
To build Julia's documentation run
```sh
$ make docs
```
from the root directory. This will build the HTML documentation and output it to the `doc/_build/` folder.
## Testing
To run the doctests found in the manual run
```sh
$ make -C doc check
```
from the root directory.
![swh spinner](/static/img/swh-spinner.gif)
Computing file changes ...