Commit Graph

12 Commits

Author SHA1 Message Date
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 'mithro' Ansell 34793fa7c5 Updating README.rst
Signed-off-by: Tim 'mithro' Ansell <tansell@google.com>
2020-06-20 22:23:07 -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 '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 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