sphinx-doc / sphinx-doc/sphinx

Table of Contents does to build in PDF

Open
#9,516 16 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

builder:latex type:question
Dominant language
Python
Stars
8k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

Describe the bug

I am unable to build a TOC in the PDF Latex of my project. The TOC builds correctly on the HTML version. When I build the project on my local Win 10 computer everything works correctly, however when the project is build on my Linux based server, the TOC of the PDF does not build. Other projects build correctly on the server.

In the link to my project please scroll down to the bottom and select "download PDF" here you can see the fault.

How to Reproduce
$ git clone https://github.com/.../some_project
$ cd some_project
$ pip install -r requirements.txt
$ cd docs
$ make html SPHINXOPTS="-D language=de"
$ # open _build/html/index and see bla bla

In the link to my project please scroll down to the bottom and select "download PDF" here you can see the fault.

Expected behavior

No response

Your project

Please contact me and I can provide a copy of the project.

Screenshots

No response

OS

Win 10 and Linx

Python version

2.1.17

Sphinx version

unknown

Sphinx extensions

No response

Extra tools

No response

Additional context

No response

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.

Research direction

Start by obtaining the project referenced in the issue and reproducing the build on the Linux server using requirements.txt and the commands under docs. Compare the working HTML output in _build/html/index with the missing PDF table of contents; done means identifying and correcting the project-specific cause of the PDF-only failure.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex, python
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.