Skip to content

Removing API docs from PDF#2299

Draft
john-science wants to merge 54 commits intomainfrom
cleanup_pdf
Draft

Removing API docs from PDF#2299
john-science wants to merge 54 commits intomainfrom
cleanup_pdf

Conversation

@john-science
Copy link
Member

@john-science john-science commented Sep 23, 2025

What is the change? Why is it being made?

WIP: Ignore for now.

Removing API docs from PDF, as they are not easy to read in PDF format, and make the ARMI docs over 1,600 pages long in PDF.

close #2288

SCR Information

Change Type: docs

One-Sentence Description: Removing API docs from PDF
One-Sentence Rationale: People were asking for a smaller PDF file.

One-line Impact on Requirements: NA


Checklist

@john-science john-science added documentation Improvements or additions to documentation cleanup Code/comment cleanup: Low Priority labels Sep 23, 2025
@john-science
Copy link
Member Author

Okay, this is proving somewhat harder than anticipated. The turn-around time on testing through github is just too long.

@john-science
Copy link
Member Author

Okay, after several attempts I have not figured out a working approach here that doesn't add 10 minutes to the build time.

So I am going to close this PR and maybe someone else will figure out a smarter approach.

@john-science john-science reopened this Jan 9, 2026
@john-science john-science requested review from opotowsky and removed request for opotowsky January 9, 2026 22:39
@john-science
Copy link
Member Author

john-science commented Jan 10, 2026

@opotowsky Commit d7dc62f finally removed the API docs from the PDF!

BUT. That completely breaks the SQA docs. Without the apidocs, Sphinx-Needs can't render the impl or test tags:

image

So, long story short, I am back to the drawing board on this.

@john-science
Copy link
Member Author

Okay, I want to try removing this line from the index.rst file to see if that is enough all on it's own:

API Docs <.apidocs/modules>

If it isn't, and I get the same problem as above, then I think there is no way to solve this without having a very different conf.py file and docs build for the PDF.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup Code/comment cleanup: Low Priority documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add option to turn off certain docs sections in the PDF

2 participants