Documenter is warning of "duplicated docs", but it isn't?

Tooling Package Management
1

For any (sub-)module of my package, I want a documentation page with:

  1. High-level documentation of the module
  2. Index of the exported functions
  3. Detailed doc of each exported function

I currently implement the page source like:


# [The BetaML.Nn Module](@id nn_module)

` ` `@docs
Nn
` ` `

## Module Index

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

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

This is rendered correctly, in this example as Nn · BetaML.jl Documentation

However, Documenter complains with:

┌ Warning: duplicate docs found for 'BetaML.Nn' in src/Nn.md:15-18
│ ```@autodocs
│ Modules = [Nn]
│ Private = false
│ ```

Is there a better way to achieve the documentation in the format I wish ? If I remove the index part, I have no index, if I remove the autodoc part, I have no doc for the functions (and other objects)…

1 Like