Commit Graph

10 Commits

Author SHA1 Message Date
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
Tim 'mithro' Ansell cff5c08524 Adding initial README.rst file.
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-05-08 09:30:06 -07:00
Tim 'mithro' Ansell 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
Tim 'mithro' Ansell 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