Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Default PDF build does not support tabbed content #302

Open
AnneCYH opened this issue Nov 6, 2024 · 1 comment
Open

Default PDF build does not support tabbed content #302

AnneCYH opened this issue Nov 6, 2024 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@AnneCYH
Copy link
Contributor

AnneCYH commented Nov 6, 2024

The default .readthedocs.yaml file includes pdf as one of the output formats (aside from HTML).

The generated PDF does not support tabbed content. The tab title + content is printed properly for the last tab; but only the tab titles are printed for the rest.

Screenshot of PDF output:
tabbed-content-pdf

Example PDF with tabbed content:
canonical-kernel-docs-readthedocs-hosted-com-en-latest.pdf

Tabbed content source:

`````{tabs}
````{tab} Noble Numbat 24.04 (and newer)

Add "deb-src" to the `Types`: line in the
{file}`/etc/apt/sources.list.d/ubuntu.sources` file.

```{code-block} text
:emphasize-lines: 1

Types: deb deb-src
URIs: http://archive.ubuntu.com/ubuntu
Suites: noble noble-updates noble-backports
Components: main universe restricted multiverse
Signed-By: /usr/share/keyrings/ubuntu-archive-keyring.gpg
```
````

````{tab} Mantic Minotaur 23.10 (and older)

Check that you have the following entries in the {file}`/etc/apt/sources.list`
file. If not, add or uncomment these lines for your Ubuntu release.
```{code-block} text

deb-src http://archive.ubuntu.com/ubuntu jammy main
deb-src http://archive.ubuntu.com/ubuntu jammy-updates main
```
````
`````
@AnneCYH AnneCYH added bug Something isn't working documentation Improvements or additions to documentation labels Nov 6, 2024
@SecondSkoll
Copy link
Collaborator

This appears to be an issue with the sphinx-tabs extension. Using the Sphinx Design tabs works for the PDF output.

`````{tab-set}
````{tab-item} Noble Numbat 24.04 (and newer)

Add "deb-src" to the `Types`: line in the
{file}`/etc/apt/sources.list.d/ubuntu.sources` file.

```{code-block} text
:emphasize-lines: 1

Types: deb deb-src
URIs: http://archive.ubuntu.com/ubuntu
Suites: noble noble-updates noble-backports
Components: main universe restricted multiverse
Signed-By: /usr/share/keyrings/ubuntu-archive-keyring.gpg
```
````

````{tab-item} Mantic Minotaur 23.10 (and older)

Check that you have the following entries in the {file}`/etc/apt/sources.list`
file. If not, add or uncomment these lines for your Ubuntu release.
```{code-block} text

deb-src http://archive.ubuntu.com/ubuntu jammy main
deb-src http://archive.ubuntu.com/ubuntu jammy-updates main
```
````
`````

Outputs to
image

We'll have to move away from the sphinx-tabs extension.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants