diff --git a/docs/contributing-integrations.rst b/docs/contributing-integrations.rst index 882731c886e..8904da950e4 100644 --- a/docs/contributing-integrations.rst +++ b/docs/contributing-integrations.rst @@ -1,3 +1,5 @@ +.. _integration_guidelines: + =========================== How To Write an Integration =========================== @@ -29,7 +31,7 @@ Your development process might look like this: - Write the integration (see more on this below). - - Open a `pull request `_ containing your changes. + - Open a :ref:`pull request` containing your changes. All integrations live in ``ddtrace/contrib/`` and contain at least two files, ``__init__.py`` and ``patch.py``. A skeleton integration is available under diff --git a/docs/contributing-testing.rst b/docs/contributing-testing.rst index f5dbbb95cd5..488e65e74ea 100644 --- a/docs/contributing-testing.rst +++ b/docs/contributing-testing.rst @@ -1,3 +1,5 @@ +.. _testing_guidelines: + Testing ======= diff --git a/docs/contributing.rst b/docs/contributing.rst index 489b60a455b..13e45012ec2 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -15,6 +15,8 @@ and `docker-compose `_. Thanks for working with us! +.. _change_process: + Change Process ============== @@ -99,7 +101,7 @@ Tests ----- If your change touches Python code, it should probably include at least one test. See the -`testing guidelines `_ for details. +:ref:`testing guidelines` for details. Documentation ------------- @@ -107,7 +109,7 @@ Documentation Pull requests implementing new features should include documentation for those features. The audience for this documentation is the public population of library users. The Products and Core logic are documented alongside this document, in the ``docs`` directory. The documentation for each Integration is contained in a docstring -in that integration's ``__init__.py`` file. See `this page `_ for more information +in that integration's ``__init__.py`` file. See :ref:`this page` for more information on writing documentation for Integrations. Logging diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst index 207374c1656..f51908fd202 100644 --- a/docs/releasenotes.rst +++ b/docs/releasenotes.rst @@ -11,7 +11,7 @@ with the library. A release note is **required** if a PR is user-impacting, or if it meets any of the following conditions: -* `Breaking change to the public API `_ +* :ref:`Breaking change to the public API` * New feature * Bug fix * Deprecations