Rst docs conversion #3496
Merged
Rst docs conversion #3496
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also use :glob: to find all cmd_*.rst instead of listing all of them.
Tries to separate the help output into more usable segments. Options are formatted into rst definition lists with code blocks for the definition.
No more printing to the command index file. Also moves the appendix ToC into the main index.
Includes .bib files for references.
KrystalDelusion
force-pushed
the
rst_docs
branch
from
80d7671
to
effb85d
Compare
|
Rebased onto master, removed unnecessary commits. |
added 7 commits
September 29, 2022 22:38
Removes need for highlight: none in cmd rst files.
added 4 commits
October 26, 2022 09:32
Also bringing the cd command help in line with others.
added 25 commits
October 31, 2022 15:12
Replaces make manual.
Table 7.1 not breaking automatically.
CellLib missed some of the tex source, particularly the \B{} function.
Uses a container to allow custom css for tighter formatting. Container replaces ..only:: html. More usage of yoscrypt instead of generic code. Updated/expanded lexer to support wider cases (also some fixes).
Can't figure out a way to have footcite work without breaking the latex build :(
Avoid breaking the old website for now
Change to rst files to use preferred image type depending on build type. pngs still exist as fallback, but html uses svg and latexpdf uses pdf.
Figures with a single include have been updated. Complicated figures are still pending.
Still at least partially placeholder.
New 011/*.tex files for combining multiple images into one for captioning. Adjusted Makefile to match. Removed command to mkdir 011 since it now has files included in git. Removed unnecessary missing_image.jpg.
Replaced citations with direct links.
As per style guide.
Also drops appendix to maxdepth 2 for consistency. Still can't figure out a way to get the command reference to list commands in the sidebar only when the user is already in the command reference. Options are: List them always, or list them never. :(
Should avoid the rst docs re-committing the pdfs when they haven't changed. Can't figure out how to make it work for the pdfs in 011.
For posterity if not functionality.
Setting width in the rst is broken and always assigns it a value of 0, so instead we define a class and just set the class to use 100% width in css.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Converting the Yosys Manual to use RST instead of pure LaTeX