PDF - add Table of content

Open
#800 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

The issue names no files, tests, or entry points. Start by locating the PDF generation path and how document heading hierarchy is represented. Done means generated PDFs include a table of contents based on that hierarchy and make long documents easier to navigate.

Written by the indexing model from the issue text.

Description

Feature Request

When a PDF is generated, it could be great if a table of content was automatically generated with the headers hierarchy.

IMHO this is necessary for long documents to be easily navigable :)

Thanks for your project which seems already great for a beta version!

Dominant language
Python
Stars
16.8k
Forks
638
Avg merge
1d 15h
Merged PRs (30d)
40

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from suitenumerique/docs

All issues in suitenumerique/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.