From da095281a836738b438a9b664af614e326e20e22 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Fri, 1 Mar 2019 05:19:10 +0000 Subject: [PATCH] docs(rtd): use internal link targets at the top of each `.rst` file * Convert the existing internal link to use `:ref:` instead --- docs/CONTRIBUTING.rst | 2 ++ docs/README.rst | 4 +++- docs/index.rst | 2 ++ 3 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst index 3735f55f..3bb945e7 100644 --- a/docs/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -1,3 +1,5 @@ +.. _contributing: + How to contribute ================= diff --git a/docs/README.rst b/docs/README.rst index 63217be4..95a3bf03 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -1,3 +1,5 @@ +.. _readme: + template-formula ================ @@ -33,7 +35,7 @@ Contributing to this repo **Commit message formatting is significant!!** -Please see `CONTRIBUTING `_ for more details. +Please see :ref:`contributing ` for more details. Available states diff --git a/docs/index.rst b/docs/index.rst index 83be5809..2d555068 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,3 +1,5 @@ +.. _index: + .. ``template-formula`` documentation master file. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive.