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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update cheatsheet to current version #13865

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

kathatherine
Copy link
Contributor

@kathatherine kathatherine commented Apr 25, 2024

Description

馃毀 Under construction 馃毀

Possibly closes #13791.

The updated text for the cheatsheet has been added to a cheatsheet/index.rst file. This could just be a cheatsheet.rst file in the user-guide folder, but my decision is currently for building with SimplePDF (below).

If it would be better to just add the text with this PR and focus on the automatic PDF build in a different one, that's also fine.

Also, would be good to have a decision on whether or not we want to keep those older cheatsheet PDFs I deleted. I know we made a simlink for a reason, but that was when we were creating them manually. (And we are very behind on them at this point.)

SimplePDF Building

The PDF will currently build locally by running sphinx-build -M simplepdf docs/source/user-guide/cheatsheet docs/_build, using the sphinx-simplepdf extension (link).

Here's the checklist for what still needs to be done with it:

  • I have an option set to true that removes the default cover. However, there's still a blank page at the beginning.
  • There's a brownish-red line across the top of each page that I can't figure out to remove or make green.
  • Add an automatic version to the footer?
  • The .readthedocs.yml needs to be updated to automatically build the PDF. https://sphinx-simplepdf.readthedocs.io/en/latest/installation.html#readthedocs-configuration has some basic options for that.
  • Once the doc builds, how do we get it automatically linked to the HTML page? And how to avoid something recursive, if what is on the HTML page is in the PDF?
  • Will we need a test for this?

Checklist - did you ...

  • Add a file to the news directory (using the template) for the next release's release notes?
  • Add / update necessary tests?
  • Add / update outdated documentation?

@conda-bot conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Apr 25, 2024
@kathatherine kathatherine mentioned this pull request May 3, 2024
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed [bot] added once the contributor has signed the CLA
Projects
Status: 馃啎 New
Development

Successfully merging this pull request may close these issues.

Update cheatsheet to current version
3 participants