Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

JunoDocs

Developer Chat Travis Docs Docs

This is the documentation for the Juno IDE, hosted at http://docs.junolab.org. It is created using Documenter.jl

Contributing to the Documentation

In order to contribute to the documentation, simply modify the files in the /docs/src folder and open a PR against the master branch. Once a PR has been opened, the CI will automatically run Documenter.jl and generate a new documentation against the PR. You can see the generate documentation on http://docs.junolab.org/previews/PR##, where ## is the PR number.

Local build of the Documentation

Although it's not necessary, if you want to check how the new documentation pages would look like in advance of opening a PR, you can build documentations locally and check the results generated in docs/build by the following step:

from the root of this repository:

$ julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path = pwd())); Pkg.instantiate()'
$ julia --project=docs/ docs/make.jl