Add links to API and links

ds-wizard · Aug 1, 2024 · c0553ed · c0553ed
1 parent 1cb69ae
commit c0553ed
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/docs/application/profile/index.rst b/docs/application/profile/index.rst
@@ -1,3 +1,5 @@
+.. _profile:
+
 Profile
 *******
 

diff --git a/docs/more/development/api.rst b/docs/more/development/api.rst
@@ -1,6 +1,6 @@
-*********************************
-Application Programming Interface
-*********************************
+*******************
+Integration via API
+*******************
 
 An Application Programming Interface (API) allows machines, such as other systems and tools, to perform actions and transfer data based on agreed-upon methods. 
 
@@ -20,7 +20,7 @@ While several public endpoints are accessible without authentication, most endpo
 Example
 =======
 
-After obtaining your authentication token and reviewing the API documentation, you can start making API calls to execute actions and transfer data, easily integrating them into your projects. Here's a simple example using the Requests library in Python:
+After obtaining your authentication token and reviewing the API documentation, you can start making API calls to execute actions and transfer data, easily integrating them into your projects. Here's a simple example using the `Requests library in Python <https://requests.readthedocs.io/en/latest/>`__:
 
 .. code-block::
 

diff --git a/docs/more/development/document-templates/tdk.rst b/docs/more/development/document-templates/tdk.rst
@@ -70,8 +70,8 @@ Environment variables and .env file
 
 You can use environment variables to authenticate:
 
-* ``DSW_API_URL`` = URL of |project_name| API with which you want to communicate. Hover mouse over your profile name to find the About section where URL is specified.
-* ``DSW_API_KEY`` = your API Key. Hover mouse over your profile name, click on :guilabel:`Edit Profile` and then navigate to :guilabel:`API Keys` From there, you can generate a new API Key for the authentication.
+* ``DSW_API_URL`` = URL of |project_name| API with which you want to communicate. Hover mouse over your profile name to find the :ref:`About<about>` section where URL is specified.
+* ``DSW_API_KEY`` = your :ref:`API Key<api-keys>`. Hover mouse over your profile name, click on :guilabel:`Edit Profile` and then navigate to :guilabel:`API Keys` From there, you can generate a new API Key for the authentication.
 
 To make this even easier, you can store those in ``.env`` file in the project root and it will be loaded automatically. Or you can specify the path to a ``.env`` file:
 

diff --git a/docs/more/development/index.rst b/docs/more/development/index.rst
@@ -21,6 +21,6 @@ This section provides information on how to develop custom content for |project_
     integration-questions/index
     Project Importers<importers>
     submission-service
+    Integration via API<api>
     contributing
     vulnerabilities
-    API<api>
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    .. _profile:
     Profile
     *******
@@ Expand Down @@