Skip to content

Commit 395a3f2

Browse files
authored
Update development.rst
Calling the sample project "sphinx-hoverxref" might be a bit confusing, and it should be made clear that "latest" refers to the documentation's version, not somehow the hoverxref version. See also PR readthedocs#79. I am not sure whether changing "latest" to "your-version" is an improvement, actually, feel free to revert that part if you disagree... the change is not too important anyway.
1 parent f9233d2 commit 395a3f2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/development.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,17 @@ To setup this approach, you need to put these settings in the ``conf.py`` of you
2121

2222
.. code-block:: python
2323
24-
hoverxref_project = 'sphinx-hoverxref'
25-
hoverxref_version = 'latest'
24+
hoverxref_project = 'your-project'
25+
hoverxref_version = 'your-version'
2626
hoverxref_api_host = 'https://readthedocs.org'
2727
2828
After building the documentation all the requests will be done to URLs like::
2929

30-
https://readthedocs.org/api/v2/embed/?project=sphinx-hoverxref&version=latest&doc=...&section=...
30+
https://readthedocs.org/api/v2/embed/?project=your-project&version=your-version&doc=...&section=...
3131

3232
.. note::
3333

34-
The project *and* version has to be successfully built on Read the Docs to return the content requested.
34+
The project *and* version (e.g. `latest`) has to be successfully built on Read the Docs to return the content requested.
3535

3636

3737
Building and serving docs locally

0 commit comments

Comments
 (0)