Commit Graph

103 Commits

Author SHA1 Message Date
Tim Ansell 9d5fe0d7cb
Merge pull request #29 from antmicro/partners
Add partners page
2020-06-29 14:16:34 -07:00
Karol Gugala efbcfff366 docs: partners: add links to logos 2020-06-29 23:09:24 +02:00
Karol Gugala f19821e512 docs: partners: move logos to separate dir 2020-06-29 21:20:59 +02:00
Karol Gugala 3eb45ffe74 Docs: add partners page 2020-06-29 20:58:11 +02:00
Tim Ansell 8318eff977
Merge pull request #25 from mithro/master
docs: Starting initial import of process documentation.
2020-06-27 12:16:36 -07:00
Tim 'mithro' Ansell acd53975a2 docs: Cleanup a bunch of sphinx warnings.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-25 19:24:22 -07:00
Tim 'mithro' Ansell 1fc041f575 docs: Adding example cell.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-25 19:23:19 -07:00
Tim 'mithro' Ansell 6926ce51f0 docs: Adding the start of the contents section.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:22:23 -07:00
Tim 'mithro' Ansell c1cdafb1a8 docs: Adding error messages output.
Updates and documentation originally improved and then release by
Kevin Kelly <kevin.kelley@skywatertechnology.com> to Google for imported
into the docutils RST format by Tim 'mithro' Ansell <tansell@google.com>.

Signed-off-by: Kevin Kelley <kevin.kelley@skywatertechnology.com>
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:13:33 -07:00
Tim 'mithro' Ansell 7303dab0db docs: Adding periphery rules.
Updates and documentation originally improved and then release by
Kevin Kelly <kevin.kelley@skywatertechnology.com> to Google for imported
into the docutils RST format by Tim 'mithro' Ansell <tansell@google.com>.

Signed-off-by: Kevin Kelley <kevin.kelley@skywatertechnology.com>
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:13:33 -07:00
Tim 'mithro' Ansell 2c2b22787b docs: Initial start on process design rules.
Updates and documentation originally improved and then release by
Kevin Kelly <kevin.kelley@skywatertechnology.com> to Google for imported
into the docutils RST format by Tim 'mithro' Ansell <tansell@google.com>.

Signed-off-by: Kevin Kelley <kevin.kelley@skywatertechnology.com>
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:13:33 -07:00
Tim 'mithro' Ansell 4ace14a741 docs: Fixing header length in known_issues.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:13:33 -07:00
Tim 'mithro' Ansell 8dc828766a docs: Stick the table headers to the top of table.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-24 16:13:33 -07:00
Tim Ansell 40da308839
Merge pull request #26 from mithro/badge-fix
docs: Fix the build badge for ReadTheDocs.
2020-06-22 18:49:24 -07:00
Tim 'mithro' Ansell 3c85e455d0 docs: Fix the build badge for ReadTheDocs.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-22 14:28:06 -07:00
Tim Ansell 3f28e0e968
Merge pull request #24 from kkiningh/patch-1
Fix 130nm inspiration doc link
2020-06-20 22:26:13 -07:00
Tim 'mithro' Ansell 34793fa7c5 Updating README.rst
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-20 22:23:07 -07:00
Kevin Kiningham 66a3ed0d28 Fix 130nm inspiration doc link 2020-06-20 22:23:07 -07:00
Tim Ansell 6d44fe1a39
Merge pull request #23 from mithro/master
docs: Fix the header links.
2020-06-19 14:22:34 -07:00
Tim 'mithro' Ansell 87725fd57d docs: Fix the header links.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-19 14:13:40 -07:00
Tim Ansell 4e9468c34d
Merge pull request #22 from mithro/master
Minor documentation updates
2020-06-18 19:56:51 -07:00
Tim 'mithro' Ansell 1a2769740a docs: Fix centering of images.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-18 18:55:20 -07:00
Tim 'mithro' Ansell 5ed81fd4d4 docs: Adding the image from the README into the docs.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-18 18:28:24 -07:00
Tim 'mithro' Ansell 83779dee6a docs: Small cleanup of auto-generated name outputs.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-18 16:14:15 -07:00
Tim 'mithro' Ansell 0f9c5cafec Fix the flash build space name.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-18 15:49:38 -07:00
Tim Ansell e039004dc7
Merge pull request #19 from mithro/metal-stack-svg
Adding SVG image of the metal_stack.
2020-06-17 12:59:03 -07:00
Tim Ansell 14a4af138f
Merge pull request #20 from mithro/users-fix
Fix link to the skywater-pdk-users group.
2020-06-17 11:56:49 -07:00
Tim 'mithro' Ansell 9ee1ae5204 Adding SVG image of the metal_stack.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
Signed-off-by: Tim Edwards <tim@efabless.com>
2020-06-17 11:56:14 -07:00
Tim 'mithro' Ansell dab6e6c2a4 Fix link to the skywater-pdk-users group.
Fixes Issue #18.

Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-16 12:30:24 -07:00
Tim Ansell a81927d793
Merge pull request #16 from mithro/api
Initial version of python-skywater-pdk module
2020-06-12 16:32:28 -07:00
Tim 'mithro' Ansell 65fa885014 docs: Lots of improvements to the documentation.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-11 14:03:59 -07:00
Tim 'mithro' Ansell ce5576edff docs: Adding the Python API to output docs.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-11 14:03:54 -07:00
Tim 'mithro' Ansell 1d603e7875 scripts: Adding initial version of the python-skywater-pdk module.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-11 14:01:44 -07:00
Tim 'mithro' Ansell 3e225d611a docs: Adding missing CSS file.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 18:30:28 -07:00
Tim 'mithro' Ansell 271859fc68 docs: Move the code of conduct under the contributing section.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 18:29:38 -07:00
Tim 'mithro' Ansell 9036e6fb82 docs: Improve the current status heading.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 18:11:50 -07:00
Tim 'mithro' Ansell cfc7208f97 docs: Add missing license header.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 18:11:50 -07:00
Tim 'mithro' Ansell 24e4310472 docs: Small improvements.
* Clean up sphinx warnings.
 * Include status in multiple locations.

Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 17:20:32 -07:00
Tim 'mithro' Ansell 87baa793ce docs: Put current status at the top of the known issues page.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 14:55:34 -07:00
Tim 'mithro' Ansell 6ed5d92680 docs: Adding .readthedocs.yml file.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 14:55:34 -07:00
Tim 'mithro' Ansell 8b323f8504 docs: Adding initial Sphinx doc structure.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 14:55:24 -07:00
Tim 'mithro' Ansell ac8ba83bc7 scripts: Adding license header checking.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 21:32:12 -07:00
Tim 'mithro' Ansell 7a530fcf20 docs: Fixing the verbatim in versioning.rst file.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:25 -07:00
Tim 'mithro' Ansell 1242fab66e docs: Adding danger block around status warning.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:22 -07:00
Tim 'mithro' Ansell 01c5bf7c8c docs: Fix the :ref: expanding.
The links to version information and known issues should now work in the
GitHub rendered preview of README.rst

Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:22 -07:00
Tim 'mithro' Ansell 79ca519b24 docs: Expand the process node information a little.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:22 -07:00
Tim 'mithro' Ansell d982b0aea7 docs: Change levels of two headings.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:22 -07:00
Tim 'mithro' Ansell 66e669a9f7 docs: Updating README.rst file.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:22 -07:00
Tim 'mithro' Ansell 8d719604ef docs: Generate README.rst to work around GitHub not rendering `.. include::` in rst files.
This work might look like extensive for just fixing a small issue like
the include rendering, but it will all be heavily reused by the
skywater-pdk scripts that will be released soon.

This commit;
 - Adds Makefile for creating a self contained conda environment under
   `env/conda`

 - Installs required Python dependencies into the environment (which is
   currently just the `rst_include` tool).

 - Has a Makefile to generate `README.rst` from `README.src.rst`

 - Has Travis CI run on repository and check that the `README.rst` file
   has been rebuilt and committed if any of the dependencies have
   change.

Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:22 -07:00
Tim 'mithro' Ansell 409742e19c docs: Adding "Known Issues" and "Versioning" sections of the documentation.
Extracted the status page into a separate file which can be included by
both the known issues and README files.

Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:16 -07:00