Skip to content

Commit

Permalink
docs: Fix hyperlinks in documentation
Browse files Browse the repository at this point in the history
Fixes #991
  • Loading branch information
ShekarArun committed Jan 31, 2024
1 parent 4d42b70 commit 7b0df48
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 19 deletions.
8 changes: 4 additions & 4 deletions docs/Options/APIReference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ REST which we are trying to migrate from as well.
REST Endpoints
------------------

Rest API Endpoints can be found here : https://prod-api.thedeep.io/api-docs/
`Rest API Endpoints documentation <https://prod-api.thedeep.io/api-docs/>`_


GraphQL Endpoints
--------------------

GraphQL Endpoints points can be found here : https://prod-api.thedeep.io/graphql-docs/
`GraphQL Endpoints documentation <https://prod-api.thedeep.io/graphql-docs/>`_

REST API
----------

A thorough documentation of the API itself can be found at */api-docs/*.
A thorough documentation of the API itself can be found at ``/api-docs/``.

**Authentication**

Expand Down Expand Up @@ -152,4 +152,4 @@ For most types of errors like forbidden, unauthorized and not found, the interna

For server errors, all except the following lists of predefined errors will have internal error code 500 by default.

* 4011 : User is not authenticated. Access token is required in the authorization header.
* 401 : User is not authenticated. Access token is required in the authorization header.
2 changes: 1 addition & 1 deletion docs/Options/AwsCopilotDeployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Setup each services
* copilot svc init --name export-worker
[Secrets](https://aws.github.io/copilot-cli/docs/commands/secret-init/)
`Secrets <https://aws.github.io/copilot-cli/docs/commands/secret-init/>`_
-------------------------------------------------------------------------
.. code-block:: bash
Expand Down
4 changes: 2 additions & 2 deletions docs/Options/Changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ export secondary data. This repository contains code for DEEP 2.0,
a large full-stack rewrite of DEEP 1.0.

DEEP's brain is powered by DEEPL, an suite of tools to provide NLP
recommendations to the platform. Its code can be found here: https://github.com/the-deep/deepl.
recommendations to the platform. `Here is its Github repo <https://github.com/the-deep/deepl>`_

More information regarding our chanelog can be found here : https://github.com/the-deep/deeper/wiki
More information regarding our changelog can be found on the `wiki <https://github.com/the-deep/deeper/wiki>`_
6 changes: 3 additions & 3 deletions docs/Options/Contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Contributing to the Backend

**Python Coding Guidelines**

- Follow [PEP 8](https://www.python.org/dev/peps/pep-0008/).
- Follow `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_.

- Use 4 spaces . . . . never tabs.

Expand All @@ -46,8 +46,8 @@ Contributing to the Backend
ProjectSerializer, ProjectMembershipSerializer
)
**Write [unit tests](https://docs.djangoproject.com/en/1.11/topics/testing/)**
Write `unit tests <https://docs.djangoproject.com/en/1.11/topics/testing/>`_

FAQ
----
Expand Down
8 changes: 7 additions & 1 deletion docs/Options/Documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,10 @@ DEEP's documentation is generated as a static page using Sphinx. During deployme
make html
#. View the generated docs by opening the index file in your browser, at the following path: :code:`<path-to-project>/docs/_build/html/index.html`
#. View the generated docs by opening the index file in your browser, at the following path: :code:`<path-to-project>/docs/_build/html/index.html`

Useful References
-----------------

* `sphinx-autobuild <https://pypi.org/project/sphinx-autobuild/>`_ is a tool that auto-builds the documentation everytime a change is detected in the ``docs/`` folder
* `rst Cheatsheet <https://bashtage.github.io/sphinx-material/rst-cheatsheet/rst-cheatsheet.html>`_ for a handy reference on reStructuredText, the markup language used by Sphinx
9 changes: 5 additions & 4 deletions docs/Options/GettingStarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@ Clone Deeper Repo

**Useful Plugins for Debugging React**

- [React Developer Tools](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en)
- [Redux DevTools](https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd?hl=en)
- `React Developer Tools <https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en>`_
- `Redux DevTools <https://chrome.google.com/webstore/detail/redux-devtools/lmhkpmbekcpmknklioeibfkpmmfibljd?hl=en>`_

**Adding dependencies [web]**

Expand Down Expand Up @@ -147,7 +147,8 @@ Clone Deeper Repo
.. code-block:: bash
docker-compose exec web bash
**Inside web container**
**Inside web container**

.. code-block:: bash
Expand All @@ -161,7 +162,7 @@ Clone Deeper Repo
docker-compose exec client bash
**Inside client container**
**Inside client container**

.. code-block:: bash
Expand Down
8 changes: 4 additions & 4 deletions docs/Options/Testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,11 @@ from project.models import Project
**References:**

[Writing Django tests](https://docs.djangoproject.com/en/1.11/topics/testing/overview/)
`Writing Django tests <https://docs.djangoproject.com/en/1.11/topics/testing/overview/>`_

[Writing API tests](http://www.django-rest-framework.org/api-guide/testing/)
`Writing API tests <http://www.django-rest-framework.org/api-guide/testing/>`_

[Test Mixin](mixin_backend.md)
`Test Mixin <mixin_backend.md>`_

FrontEnd
========
Expand Down Expand Up @@ -159,7 +159,7 @@ To test redux-connected components, one can use the `redux-mock-store`:
});
});
More examples using redux: [writing tests](https://github.com/reactjs/redux/blob/master/docs/recipes/WritingTests.md).
More examples using redux: `Writing tests <https://github.com/reactjs/redux/blob/master/docs/recipes/WritingTests.md>`_.
For event based behavioral testing, Enzyme's `simulate` can be used as helper method.
Expand Down

0 comments on commit 7b0df48

Please sign in to comment.