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>
diff --git a/Makefile b/Makefile
index 0bb8b96..7c88b73 100644
--- a/Makefile
+++ b/Makefile
@@ -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
diff --git a/README.rst b/README.rst
index 218694b..b9db567 100644
--- a/README.rst
+++ b/README.rst
@@ -44,13 +44,13 @@
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
===================
