Documentation and Tutorials for Turing.jl

This repository is part of Turing.jl's website (i.e. https://turinglang.org/docs/). It contains the Turing.jl documentation and tutorials.

• The master branch contains the quarto source
• The gh-pages branch contains the html version of these documents compiled from the master branch.

To get started with the docs website locally, you'll need to have Quarto installed. Make sure you have at least version 1.5 of Quarto installed, as this is required to correctly run the native Julia engine.

Once you have the prerequisite installed, you can follow these steps:

1. Clone this repository:

   git clone https://github.com/TuringLang/docs

2. Navigate into the cloned directory:

   cd docs

3. Instantiate the project environment:

   julia --project=. -e 'using Pkg; Pkg.instantiate()'

4. Preview the website using Quarto Preview:

   quarto preview

   This will launch a local server at http://localhost:4200/, which you can view in your web browser by navigating to the link shown in your terminal. Note: Avoid clicking links in the navbar while previewing locally because they will eventually lead to https links online!

5. Render the website locally:

   quarto render

   This will render the full website in _site folder.

   It is also possible to render a single tutorial or qmd file without compiling the entire site. This is often helpful to speed up compilation when editing a single docs page. To do this, pass the qmd file as an argument to quarto render:

   quarto render path/to/index.qmd
   

License

This project is licensed under the MIT License - see the LICENSE file for details.