riscv
/
skywater-pdk
mirror of https://github.com/google/skywater-pdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Tim 'mithro' Ansell 2020-05-08 19:46:32 -07:00
parent 79ca519b24
commit 01c5bf7c8c
2 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Makefile
View File

@ -17,6 +17,19 @@
include scripts/make/git.mk
include scripts/make/conda.mk
README.rst: README.src.rst docs/status.rst | $(CONDA_ENV_PYTHON)
.DEFAULT_GOAL := all
README.rst: README.src.rst docs/status.rst Makefile | $(CONDA_ENV_PYTHON)
@rm -f README.rst
$(IN_CONDA_ENV) rst_include include --source README.src.rst | sed -e's/|TAG_VERSION|/$(TAG_VERSION)/g' > README.rst
$(IN_CONDA_ENV) rst_include include --source README.src.rst \
| sed \
-e's@|TAG_VERSION|@$(TAG_VERSION)@g' \
-e's@:ref:`Versioning Information`@`Versioning Information <docs/versioning.rst>`_@g' \
-e's@:ref:`Known Issues`@`Versioning Information <docs/known_issues.rst>`_@g' \
> README.rst
all: README.rst
@true
.PHONY: all

4
README.rst
View File

@ -44,13 +44,13 @@ While the SKY130 process node and the PDK from which this open source release wa
Google, SkyWater and our partners are currently doing internal validation and test designs, including silicon validation or the released data and plan to publish these results.
The PDK will be tagged with a production version when ready to do production design, see the ":ref:`Versioning Information`" section for a full description of the version numbering scheme.
The PDK will be tagged with a production version when ready to do production design, see the "`Versioning Information <docs/versioning.rst>`_" section for a full description of the version numbering scheme.
To get notified about future new releases of the PDK, and other important news, please sign up on the
`skywater-pdk-announce mailing list <https://groups.google.com/forum/#!forum/skywater-pdk-announce>`_
[`join link <https://groups.google.com/forum/#!forum/skywater-pdk-announce/join>`_].
See both the :ref:`Known Issues` section and the `SkyWater PDK GitHub issue list <https://github.com/google/skywater-pdk/issues>`_ to get more detailed information around currently known issues.
See both the `Versioning Information <docs/known_issues.rst>`_ section and the `SkyWater PDK GitHub issue list <https://github.com/google/skywater-pdk/issues>`_ to get more detailed information around currently known issues.
SKY130 Process Node
===================