From 168751a7b7ca02dc33601f924302982a7267a52e Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Fri, 30 Aug 2019 14:06:14 -0700 Subject: [PATCH] doc: fix broken doc links The project's README.rst references the support board docs with an URL that's not working these days (see https://github.com/zephyrproject-rtos/infrastructure/issues/134) so fix that URL reference. While looking for other similar linking cases, I found a hard URL references that should be using :ref: role, and a release notes reference to a (now) broken link (fixing that in the /latest/ version of the 1.10 release notes). Signed-off-by: David B. Kinder --- README.rst | 2 +- boards/riscv/qemu_riscv64/doc/index.rst | 3 +-- doc/getting_started/index.rst | 2 ++ doc/releases/release-notes-1.10.rst | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index fb8d2b8db473..4d11c0f43701 100644 --- a/README.rst +++ b/README.rst @@ -72,7 +72,7 @@ Here's a quick summary of resources to help you find your way around: * **Zephyr Project Website**: https://zephyrproject.org .. _Slack Invite: https://tinyurl.com/y5glwylp -.. _supported boards: http://docs.zephyrproject.org/latest/boards +.. _supported boards: http://docs.zephyrproject.org/latest/boards/index.html .. _Zephyr Documentation: http://docs.zephyrproject.org .. _Introduction to Zephyr: http://docs.zephyrproject.org/latest/introduction/index.html .. _Getting Started Guide: http://docs.zephyrproject.org/latest/getting_started/index.html diff --git a/boards/riscv/qemu_riscv64/doc/index.rst b/boards/riscv/qemu_riscv64/doc/index.rst index b3580caf3857..e28463bd1c84 100644 --- a/boards/riscv/qemu_riscv64/doc/index.rst +++ b/boards/riscv/qemu_riscv64/doc/index.rst @@ -21,8 +21,7 @@ Get the Toolchain and QEMU The minimum version of the `Zephyr SDK tools `_ with toolchain and QEMU support for the RISV64 architecture is v0.10.2. -Please see the `installation instructions -`_ +Please see the :ref:`installation instructions ` for more details. Programming and Debugging diff --git a/doc/getting_started/index.rst b/doc/getting_started/index.rst index d074f2475fdb..29d3bf0b9afb 100644 --- a/doc/getting_started/index.rst +++ b/doc/getting_started/index.rst @@ -44,6 +44,8 @@ package is already installed locally but a more recent version is available. It is good practice to use this flag if the latest version of a package is required. +.. _install-required-tools: + Install the required tools =========================== diff --git a/doc/releases/release-notes-1.10.rst b/doc/releases/release-notes-1.10.rst index f7d26dfd73d2..22e35c8fcaaf 100644 --- a/doc/releases/release-notes-1.10.rst +++ b/doc/releases/release-notes-1.10.rst @@ -138,7 +138,7 @@ Build and Infrastructure either simple one-to-one translations of KBuild features or introduce new concepts that replace KBuild concepts. Please re-read the Getting Started guide - (https://docs.zephyrproject.org/getting_started/getting_started.html) + (https://docs.zephyrproject.org/1.10.0/getting_started/getting_started.html) with updated instructions for setting up and developing on your host-OS. You *will* need to port your own out-of-tree scripts and Makefiles to CMake.