Skip to content

[#290] Add table of contents to autodoc

Moremi Vannak requested to merge rinn7e/#290-add-table-of-contents into master

Description

Problem: Automatically generated documentation is quite long and the navigation is a bit hard. There is no way to make md automatically generate ToC, but since autodoc is generated automatically, we can generate ToC ourselves and thus ensure that it's up-to-date.

Solution: Add a way to generate Table of contents automatically for autodoc.

Related issue(s)

Resolves #290 (closed)

Checklist for your Merge Request

Related changes (conditional)

  • Tests (see short guidelines)

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
  • Documentation

    • I checked whether I should update the docs and did so if necessary:
    • I updated changelog files of all affected packages released to Hackage if my changes are externally visible.

Stylistic guide (mandatory)

Edited by Moremi Vannak

Merge request reports