# Automatic documentation of entire package

**URL:** <https://discourse.julialang.org/t/automatic-documentation-of-entire-package/106616>\
**Category:** General Usage\
**Tags:** documentation, documenter\
**Created:** [November 23, 2023, 8:39am UTC](https://discourse.julialang.org/t/automatic-documentation-of-entire-package/106616 "2023-11-23T08:39:46Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![greatpet](https://avatars.discourse-cdn.com/v4/letter/g/e495f1/32.png) [@greatpet](https://discourse.julialang.org/u/greatpet)\
**Post date:** [November 23, 2023, 8:39am UTC](https://discourse.julialang.org/t/automatic-documentation-of-entire-package/106616/1 "2023-11-23T08:39:46Z")

</div>

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`?

---

<div class="post-metadata">

**Author:** ![sylvaticus](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/sylvaticus/32/203883_2.png) [@sylvaticus](https://discourse.julialang.org/u/sylvaticus)\
**Post date:** [November 23, 2023, 8:52am UTC](https://discourse.julialang.org/t/automatic-documentation-of-entire-package/106616/2 "2023-11-23T08:52:50Z")

</div>

Yes, there are various macros (and options) to list all functions of a given module, e.g. this is [doc source](https://github.com/sylvaticus/BetaML.jl/blob/master/docs/src/Imputation.md) for the `Imputation` submodule of my [BetaML](https://github.com/sylvaticus/BetaML.jl) package:

```julia
# [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](https://sylvaticus.github.io/BetaML.jl/dev/Imputation.html)