Automatic documentation of entire package

General Usage
,
1

Can Documenter.jl automatically generate documentation for an entire package by collecting all docstrings from all source files, instead of just the functions specified by the user in index.md?

2

Yes, there are various macros (and options) to list all functions of a given module, e.g. this is doc source for the Imputation submodule of my BetaML package:

# [The BetaML.Imputation Module](@id imputation_module)

` ` `@docs
Imputation
` ` `

## Module Index

` ` `@index
Modules = [Imputation]
Order   = [:function, :constant, :type, :macro]
Private = false
` ` `
## Detailed API

` ` `@autodocs
Modules = [Imputation]
Private = false
` ` `

(the spaces between the 3 back commas are to keep the formatting here in Discourse)

This results in the following rendered page:
https://sylvaticus.github.io/BetaML.jl/dev/Imputation.html

2 Likes