Hide navigation sidebar

Hide table of contents sidebar

Skip to content

Toggle site navigation sidebar

Dune documentation

Toggle table of contents sidebar

Dune documentation

Getting Started and Core Concepts
Toggle navigation of Getting Started and Core Concepts
Tutorials
Toggle navigation of Tutorials
- Developing with Dune
  Toggle navigation of Developing with Dune
- OCaml Package Management With Dune
  Toggle navigation of OCaml Package Management With Dune
How-to Guides
Toggle navigation of How-to Guides
Reference Manual
Toggle navigation of Reference Manual
- dune
  Toggle navigation of dune
  - executable
  - executables
  - library
  - foreign_library
  - deprecated_library_name
  - generate_sites_module
  - test
  - tests
  - Cram
  - toplevel
  - documentation
  - install
  - plugin
  - rule
  - alias
  - copy_files
  - include
  - dynamic_include
  - env
  - dirs
  - data_only_dirs
  - ignored_subdirs
  - include_subdirs
  - vendored_dirs
  - subdir
  - cinaps
  - coq.theory
  - mdx
  - menhir
  - ocamllex
  - ocamlyacc
  - jbuild_version
- dune-project
  Toggle navigation of dune-project
- dune-workspace
  Toggle navigation of dune-workspace
  - config stanzas
  - context
  - env
  - profile
- config
  Toggle navigation of config
- Lexical Conventions
- Actions
  Toggle navigation of Actions
  - run
  - system
  - bash
  - dynamic-run
  - chdir
  - setenv
  - with-accepted-exit-codes
  - echo
  - with-<outputs>-to
  - with-stdin-from
  - ignore-<outputs>
  - cat
  - copy
  - copy#
  - write-file
  - pipe-<outputs>
  - diff
  - diff?
  - cmp
  - progn
  - concurrent
  - no-infer
- Ordered Set Language
- Boolean Language
- Predicate Language
- Library Dependencies
- Preprocessing Specification
- Cram Tests
- Scopes
- Variables
- Dependency Specification
- OCaml Flags
- Sandboxing
- Locks
- Diffing and Promotion
- Package Specification
- Aliases
  Toggle navigation of Aliases
  - @all
  - @default
  - @install
  - @pkg-install
  - @check
  - @ocaml-index
  - @runtest
  - @fmt
  - @lint
  - @doc
  - @doc-private
  - @doc-json
- Foreign Stubs
- Foreign Archives
- Extra Objects
- Flags in Foreign Code
- Command Line Interface
- Dune Libraries
- Dune Cache
- Coq
- Dune RPC
- Packages
- Findlib Integration
Explanation
Toggle navigation of Explanation
- How Preprocessing Works
- The OCaml Ecosystem
- How Package Management Works
- How Dune integrates with opam
- How Dune Uses Dune to Build Dune
- The Dune Mental Model
- A Tour of the Dune Codebase
  Toggle navigation of A Tour of the Dune Codebase
Advanced Topics
Toggle navigation of Advanced Topics
Miscellaneous
Toggle navigation of Miscellaneous

Toggle table of contents sidebar

@doc¶

This alias builds documentation for public libraries as HTML pages.

See also

Generating Documentation

Copyright © 2017, Jérémie Dimino

Made with Sphinx and @pradyunsg's Furo