/juliaimages.github.io

Documentation For JuliaImages

Primary LanguageJulia

juliaimages.org

Documentation For JuliaImages, the organization for image processing with Julia.

Build Status

See also the dashboard for individual packages.

Note that the source files for the documentation are on the source branch; master is used only for deploying the generated HTML content.

Adding demos

Users are invited to add demonstrations carrying out particular tasks, for example like the gallery for scikit-image. The current procedure is as follows:

  • git clone a copy of this repository and initialize the project by julia --project=. -e 'using Pkg; Pkg.instantiate()'
  • write your julia source codes to docs/examples in Literate Syntax and Documenter Syntax. Powered by DemoCards.jl, assets can be generated on the fly.
  • Build the documentation locally with julia --project=. docs/make.jl. Inspect it (by opening docs/build/index.html in a browser) to make sure all is well.
  • Commit your changes (including all new files) and submit a pull request.

DemoCards.jl as a plugin package to Documenter is used to manage all the demos, check the DemoCards Quickstart for more details.