1a2769740a
docs: Fix centering of images.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-18 18:55:20 -07:00
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
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
0f9c5cafec
Fix the flash build space name.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-18 15:49:38 -07:00
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
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
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
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
a81927d793
Merge pull request #16 from mithro/api
...
Initial version of python-skywater-pdk module
2020-06-12 16:32:28 -07:00
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
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
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
3e225d611a
docs: Adding missing CSS file.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 18:30:28 -07:00
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
9036e6fb82
docs: Improve the current status heading.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 18:11:50 -07:00
cfc7208f97
docs: Add missing license header.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 18:11:50 -07:00
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
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
6ed5d92680
docs: Adding .readthedocs.yml file.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 14:55:34 -07:00
8b323f8504
docs: Adding initial Sphinx doc structure.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-14 14:55:24 -07:00
ac8ba83bc7
scripts: Adding license header checking.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 21:32:12 -07:00
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
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
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
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
d982b0aea7
docs: Change levels of two headings.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:22 -07:00
66e669a9f7
docs: Updating README.rst file.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 20:54:22 -07:00
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
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
cff5c08524
Adding initial README.rst file.
...
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 09:30:06 -07:00
15547a70a3
Convert docs from Markdown to RST.
...
This repository will use RST heavily for all it's documentation and it
is good for these documents to be the same.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-07 14:35:04 -07:00
53e4356d8a
Boilerplate for new Google open source project
...
Based on bc6327f077d9a712f022310f1e8c8258fa297b8d from
https://github.com/google/new-project template.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-07 14:34:53 -07:00
Tim 'mithro' Ansell
Tim Ansell