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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rst docs conversion #3496

Merged
merged 51 commits into from
Nov 15, 2022
Merged

Rst docs conversion #3496

merged 51 commits into from
Nov 15, 2022

Commits on Sep 29, 2022

  1. Add RST generator and templates

    mmicko authored and KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    b96f5be View commit details
    Browse the repository at this point in the history
  2. Support older compilers

    mmicko authored and KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    fcea513 View commit details
    Browse the repository at this point in the history
  3. Cleaner rst dump

    Also use :glob: to find all cmd_*.rst instead of listing all of them.
    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    8ab7c35 View commit details
    Browse the repository at this point in the history
  4. Python script to reformat

    Tries to separate the help output into more usable segments.  Options are formatted into rst definition lists with code blocks for the definition.
    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    d356ec3 View commit details
    Browse the repository at this point in the history
  5. Makefile target for generation and formatting

    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    665fe80 View commit details
    Browse the repository at this point in the history
  6. Tabs to spaces

    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    fd661b2 View commit details
    Browse the repository at this point in the history
  7. Converting the manual

    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    60d26c1 View commit details
    Browse the repository at this point in the history
  8. Moved format.py content into register.cc

    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    ab23813 View commit details
    Browse the repository at this point in the history
  9. Changing formatting to a fixed cmd_ref

    No more printing to the command index file.
    Also moves the appendix ToC into the main index.
    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    33602fd View commit details
    Browse the repository at this point in the history
  10. Working on formatting for latexpdf

    Includes .bib files for references.
    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    d6e6403 View commit details
    Browse the repository at this point in the history
  11. Including Chapters (part.1)

    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    effb85d View commit details
    Browse the repository at this point in the history
  12. Changing default highlight_language to none

    Removes need for highlight: none in cmd rst files.
    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    3acdbb8 View commit details
    Browse the repository at this point in the history
  13. Adding images for Approach and Overview

    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    37751cc View commit details
    Browse the repository at this point in the history
  14. Including Chapters (part.2)

    KrystalDelusion committed Sep 29, 2022
    Configuration menu
    Copy the full SHA
    00bcdf2 View commit details
    Browse the repository at this point in the history

Commits on Oct 3, 2022

  1. Oops

    KrystalDelusion committed Oct 3, 2022
    Configuration menu
    Copy the full SHA
    a6e6870 View commit details
    Browse the repository at this point in the history
  2. Including Chapters (part.3)

    KrystalDelusion committed Oct 3, 2022
    Configuration menu
    Copy the full SHA
    368705f View commit details
    Browse the repository at this point in the history

Commits on Oct 4, 2022

  1. Line numbers in RTLIL/Bison code sections

    KrystalDelusion committed Oct 4, 2022
    Configuration menu
    Copy the full SHA
    e956fd4 View commit details
    Browse the repository at this point in the history

Commits on Oct 5, 2022

  1. Working on appendices

    KrystalDelusion committed Oct 5, 2022
    Configuration menu
    Copy the full SHA
    047b544 View commit details
    Browse the repository at this point in the history

Commits on Oct 18, 2022

  1. Adding appendix 011

    KrystalDelusion committed Oct 18, 2022
    Configuration menu
    Copy the full SHA
    aa49dc5 View commit details
    Browse the repository at this point in the history

Commits on Oct 19, 2022

  1. Adding 012

    KrystalDelusion committed Oct 19, 2022
    Configuration menu
    Copy the full SHA
    8e168ab View commit details
    Browse the repository at this point in the history
  2. RTLIL syntax highlighting

    KrystalDelusion committed Oct 19, 2022
    Configuration menu
    Copy the full SHA
    61f3959 View commit details
    Browse the repository at this point in the history

Commits on Oct 20, 2022

  1. Yoscrypt lexing

    KrystalDelusion committed Oct 20, 2022
    Configuration menu
    Copy the full SHA
    ca47067 View commit details
    Browse the repository at this point in the history

Commits on Oct 25, 2022

  1. More edge handling in help -> rst conversion

    Also bringing the cd command help in line with others.
    KrystalDelusion committed Oct 25, 2022
    Configuration menu
    Copy the full SHA
    3151a95 View commit details
    Browse the repository at this point in the history
  2. General tidying

    KrystalDelusion committed Oct 25, 2022
    Configuration menu
    Copy the full SHA
    2455b9b View commit details
    Browse the repository at this point in the history

Commits on Oct 31, 2022

  1. Remove luximono

    KrystalDelusion committed Oct 31, 2022
    Configuration menu
    Copy the full SHA
    57f46d2 View commit details
    Browse the repository at this point in the history
  2. Hacky fix for RTD to find util folder

    KrystalDelusion committed Oct 31, 2022
    Configuration menu
    Copy the full SHA
    512b9ec View commit details
    Browse the repository at this point in the history
  3. Adding requirements.txt

    KrystalDelusion committed Oct 31, 2022
    Configuration menu
    Copy the full SHA
    5d02bba View commit details
    Browse the repository at this point in the history
  4. Moving make targets to top level

    Replaces make manual.
    KrystalDelusion committed Oct 31, 2022
    Configuration menu
    Copy the full SHA
    b843e10 View commit details
    Browse the repository at this point in the history
  5. Fixes for documentation

    Table 7.1 not breaking automatically.
    CellLib missed some of the tex source, particularly the \B{} function.
    KrystalDelusion committed Oct 31, 2022
    Configuration menu
    Copy the full SHA
    4a3bc54 View commit details
    Browse the repository at this point in the history
  6. Use built yosys so it doesn't need to be installed

    KrystalDelusion committed Oct 31, 2022
    Configuration menu
    Copy the full SHA
    137a52c View commit details
    Browse the repository at this point in the history
  7. Fix 012 btor scripts

    KrystalDelusion committed Oct 31, 2022
    Configuration menu
    Copy the full SHA
    a52d7c9 View commit details
    Browse the repository at this point in the history
  8. Better formatting for html cmdref

    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).
    KrystalDelusion committed Oct 31, 2022
    Configuration menu
    Copy the full SHA
    c4be93d View commit details
    Browse the repository at this point in the history

Commits on Nov 2, 2022

  1. Further reducing cmdref whitespace

    KrystalDelusion committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    0d39bbf View commit details
    Browse the repository at this point in the history
  2. Bib fixes

    KrystalDelusion committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    7c83913 View commit details
    Browse the repository at this point in the history
  3. Moving bibliography to separate page

    Can't figure out a way to have footcite work without breaking the latex build :(
    KrystalDelusion committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    cafcf8a View commit details
    Browse the repository at this point in the history
  4. Bringing back tex manual commands

    Avoid breaking the old website for now
    KrystalDelusion committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    8fb288f View commit details
    Browse the repository at this point in the history
  5. Docs make target more in line with others

    KrystalDelusion committed Nov 2, 2022
    Configuration menu
    Copy the full SHA
    1339fda View commit details
    Browse the repository at this point in the history

Commits on Nov 3, 2022

  1. Replacing png images with generated svg/pdf

    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.
    KrystalDelusion committed Nov 3, 2022
    Configuration menu
    Copy the full SHA
    8391838 View commit details
    Browse the repository at this point in the history
  2. Compilation for 011 dot files

    Figures with a single include have been updated.
    Complicated figures are still pending.
    KrystalDelusion committed Nov 3, 2022
    Configuration menu
    Copy the full SHA
    98f55c8 View commit details
    Browse the repository at this point in the history

Commits on Nov 6, 2022

  1. mkdir 011 from docs/images/Makefile

    KrystalDelusion committed Nov 6, 2022
    Configuration menu
    Copy the full SHA
    0877fab View commit details
    Browse the repository at this point in the history
  2. Remove unused svg package

    KrystalDelusion committed Nov 6, 2022
    Configuration menu
    Copy the full SHA
    52a0238 View commit details
    Browse the repository at this point in the history
  3. Adding instructions to readme

    Still at least partially placeholder.
    KrystalDelusion committed Nov 6, 2022
    Configuration menu
    Copy the full SHA
    f93a50e View commit details
    Browse the repository at this point in the history
  4. Last of the missing images

    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.
    KrystalDelusion committed Nov 6, 2022
    Configuration menu
    Copy the full SHA
    46f619a View commit details
    Browse the repository at this point in the history

Commits on Nov 8, 2022

  1. Removing weblinks.bib

    Replaced citations with direct links.
    KrystalDelusion committed Nov 8, 2022
    Configuration menu
    Copy the full SHA
    bbccd87 View commit details
    Browse the repository at this point in the history
  2. Titles now consistently sentence case

    As per style guide.
    KrystalDelusion committed Nov 8, 2022
    Configuration menu
    Copy the full SHA
    f7f9331 View commit details
    Browse the repository at this point in the history
  3. Moving bib above cmd_ref

    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.
    :(
    KrystalDelusion committed Nov 8, 2022
    Configuration menu
    Copy the full SHA
    f289471 View commit details
    Browse the repository at this point in the history
  4. Omitting metadata from pdflatex

    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.
    KrystalDelusion committed Nov 8, 2022
    Configuration menu
    Copy the full SHA
    db7ee35 View commit details
    Browse the repository at this point in the history
  5. And the same for the 011 tex files

    For posterity if not functionality.
    KrystalDelusion committed Nov 8, 2022
    Configuration menu
    Copy the full SHA
    2ce2bc7 View commit details
    Browse the repository at this point in the history

Commits on Nov 9, 2022

  1. css override for width

    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.
    KrystalDelusion committed Nov 9, 2022
    Configuration menu
    Copy the full SHA
    e611adf View commit details
    Browse the repository at this point in the history
  2. Code highlighting

    KrystalDelusion committed Nov 9, 2022
    Configuration menu
    Copy the full SHA
    8538b39 View commit details
    Browse the repository at this point in the history

Commits on Nov 14, 2022

  1. Switching to max-width override instead of width

    KrystalDelusion committed Nov 14, 2022
    Configuration menu
    Copy the full SHA
    73fe48b View commit details
    Browse the repository at this point in the history