Skip to content
This repository was archived by the owner on Apr 9, 2025. It is now read-only.

Commit f51003c

Browse files
make the page easy to comprehend
1 parent 5929912 commit f51003c

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/development.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Development
22
===========
33

4-
This is a very small guide to help with the development of this extension.
5-
Since it needs a backend and the event is only triggered only on mouse hover,
4+
This is a very small guide to help with the testing of this extension.
5+
Since it needs a backend and the event is only triggered on mouse hover,
66
it could be tedious if you don't know these tips & tricks.
77

88
Backend
@@ -15,7 +15,7 @@ Using readthedocs.org as backend
1515
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1616

1717
This is the easiest way to have the backend working, since you do not need to do anything.
18-
Although, you need to use an already existent project in Read the Docs.
18+
Although, you need to use an already existing project in Read the Docs.
1919

2020
To setup this approach, you need to put these settings in the ``conf.py`` of your docs:
2121

@@ -29,7 +29,7 @@ After building the documentation all the requests will be done to URLs like::
2929

3030
.. note::
3131

32-
The project *and* version has to be successfully built on Read the Docs to return the content requested.
32+
The project *and* version have to be successfully built on Read the Docs to return the content requested.
3333

3434

3535
Building and serving docs locally
@@ -60,7 +60,7 @@ Using a local Read the Docs instance
6060
You can `install Read the Docs locally following these instructions`_.
6161
Although, it may be too complicated just to retrieve the same content that you could have in https://readthedocs.org.
6262

63-
To make the extension to work, you will need to define this setting in your ``conf.py`` file:
63+
To make the extension work, you will need to define this setting in your ``conf.py`` file:
6464

6565
.. code-block:: python
6666
@@ -73,7 +73,7 @@ To make the extension to work, you will need to define this setting in your ``co
7373
Once you have done that, you can just import the project directly in your local instance,
7474
and the tooltips should work without problem.
7575

76-
.. _install Read the Docs locally following these instructions: https://docs.readthedocs.io/en/stable/development/install.html
76+
.. _install Read the Docs locally following these instructions: https://docs.readthedocs.io/en/stable/install.html
7777

7878

7979
Modifying ``hoverxref.js`` on the fly

0 commit comments

Comments
 (0)