documentation home

Automatic sectioning

By default, only part of the the resources are shown in the main panel. These resource sections are derived automatically based on the structure of the resource tree.

If you rather have all documentation on a single page, you also indicate this by setting the sections-strategy. Possible values are: auto (default) and singlepage Mind that for very large documentations, single page can lead to a slow documentation site.

Maven
<output>
   <html>
      <sections>
         <strategy>singlepage</strategy>
      </sections>
   </html>
</output>
Gradle
output {
   formats {
      'html' {
         sections {
            strategy = 'singlepage'
         }
      }
   }
}

Example output: The first image has a auto sectioning, the second has single page documentation.