Skip to content

Update documentation #3911

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Update documentation #3911

wants to merge 7 commits into from

Conversation

clumens
Copy link
Contributor

@clumens clumens commented Jul 3, 2025

The primary goal of this was to address T252, but while I was there, I found that the tables of contents were all screwed up (at least in the PDF docs). This should be backported to 3.0 as well.

clumens added 7 commits July 3, 2025 09:21
Additionally, widths are supposed to be percentages and not ratios.
It's possible they can be used like that, but upstream documentation
describes them as percentages.  So, I've gone through and changed all
those and made sure they look good.

Ref T252
Additionally, widths are supposed to be percentages and not ratios.
It's possible they can be used like that, but upstream documentation
describes them as percentages.  So, I've gone through and changed all
those and made sure they look good.

Fixes T252
Prior to this patch, in the PDF documentation, the abstract was chapter
1, the table of contents was chapter 2, and the index was chapter 3.
All the content of the book was in subheadings under chapter 2, which is
not really what we're looking for.

Now, the abstract is no longer its own chapter - it's just some text on
its own page following the table of contents - and the actual book
follows in its own chapters.
@clumens clumens requested a review from nrwahl2 July 3, 2025 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant