Update cheatsheet to current version #13865
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 acheatsheet.rst
file in theuser-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 thesphinx-simplepdf
extension (link).Here's the checklist for what still needs to be done with it:
.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.Checklist - did you ...
news
directory (using the template) for the next release's release notes?