diff options
| author | Miodrag Milanović <mmicko@gmail.com> | 2023-01-02 16:07:36 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-02 16:07:36 +0100 |
| commit | 257b41cd1fc3f5ce73fd111e7014150f46af833c (patch) | |
| tree | 33aedbe2ca1f0420b182a7dea8606078044902b4 /guidelines | |
| parent | 3ebc50dee4007f8cca4ffc0e850bc3e86f7641f4 (diff) | |
| parent | f2a4e5f1a077e7980598114adf33951132e60785 (diff) | |
| download | yosys-257b41cd1fc3f5ce73fd111e7014150f46af833c.tar.gz yosys-257b41cd1fc3f5ce73fd111e7014150f46af833c.tar.bz2 yosys-257b41cd1fc3f5ce73fd111e7014150f46af833c.zip | |
Merge pull request #3577 from KrystalDelusion/deprecate_manual
Deprecate manual
Diffstat (limited to 'guidelines')
| -rw-r--r-- | guidelines/Checklists | 14 | ||||
| -rw-r--r-- | guidelines/GettingStarted | 2 |
2 files changed, 6 insertions, 10 deletions
diff --git a/guidelines/Checklists b/guidelines/Checklists index cc61c7876..51756cfd7 100644 --- a/guidelines/Checklists +++ b/guidelines/Checklists @@ -11,7 +11,7 @@ Things to do right away: Things to do after finalizing the cell interface: - Add support to kernel/satgen.h for the new cell type - - Add to manual/CHAPTER_CellLib.tex (or just add a fixme to the bottom) + - Add to docs/source/CHAPTER_CellLib.rst (or just add a fixme to the bottom) - Maybe add support to the Verilog backend for dumping such cells as expression @@ -29,11 +29,9 @@ Update the CHANGELOG file: Update and check documentation: cd ~yosys - make update-manual - make manual - - sanity check the figures in the appnotes and presentation + make docs + - sanity check the figures in docs/images - if there are any odd things -> investigate - - make cosmetic changes to the .tex files if necessary cd ~yosys vi README guidelines/* @@ -108,13 +106,11 @@ Release: Updating the website: cd ~yosys - make manual make install - - update pdf files on the website - cd ~yosys-web - make update_cmd make update_show git commit -am update make push + + - Read the Docs updates handled by Jenkins on source change diff --git a/guidelines/GettingStarted b/guidelines/GettingStarted index fcc84c153..d27b285fc 100644 --- a/guidelines/GettingStarted +++ b/guidelines/GettingStarted @@ -191,7 +191,7 @@ Example Code The following yosys commands are a good starting point if you are looking for examples of how to use the Yosys API: - manual/CHAPTER_Prog/stubnets.cc + docs/source/CHAPTER_Prog/stubnets.cc manual/PRESENTATION_Prog/my_cmd.cc |