1
1
Development
2
2
===========
3
3
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,
6
6
it could be tedious if you don't know these tips & tricks.
7
7
8
8
Backend
@@ -15,7 +15,7 @@ Using readthedocs.org as backend
15
15
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16
16
17
17
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.
19
19
20
20
To setup this approach, you need to put these settings in the ``conf.py `` of your docs:
21
21
@@ -29,7 +29,7 @@ After building the documentation all the requests will be done to URLs like::
29
29
30
30
.. note ::
31
31
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.
33
33
34
34
35
35
Building and serving docs locally
@@ -60,7 +60,7 @@ Using a local Read the Docs instance
60
60
You can `install Read the Docs locally following these instructions `_.
61
61
Although, it may be too complicated just to retrieve the same content that you could have in https://readthedocs.org.
62
62
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:
64
64
65
65
.. code-block :: python
66
66
@@ -73,7 +73,7 @@ To make the extension to work, you will need to define this setting in your ``co
73
73
Once you have done that, you can just import the project directly in your local instance,
74
74
and the tooltips should work without problem.
75
75
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
77
77
78
78
79
79
Modifying ``hoverxref.js `` on the fly
0 commit comments