Skip to content

Latest commit

 

History

History
21 lines (13 loc) · 979 Bytes

Readme.md

File metadata and controls

21 lines (13 loc) · 979 Bytes

Building Docs

To locally build the docs, run the following commands from root of the repository to Instantiate the docs environment and build the docs.

julia -e 'using Pkg; Pkg.activate("./docs"); Pkg.instantiate(); include("./docs/make.jl");'

The build results will be stored under docs/build.

Alternatively, if you have ProbabilisticCircuits in development mode and have already instantiated the docs environment, you can simply run the following.

julia --project=docs docs/make.jl

Note that if you do not have the package in the development mode, the docs build would most likely ignore the uncommited changes.

Note about Pretty URLs

For easier navigation for local builds its probably easier to disable pretty URLs. To disable that, go to make.jl and set prettyurls = false. For more information about pretty URLs, check out the documentation for Documenter.jl.