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

Commit 8b0c706

Browse files
committed
Update documentation
1 parent a99bb7b commit 8b0c706

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

docs/configuration.rst

+5-6
Original file line numberDiff line numberDiff line change
@@ -153,16 +153,15 @@ These settings are global and have effect on both, tooltips and modal dialogues.
153153
.. _Mathjax: http://www.sphinx-doc.org/es/master/usage/extensions/math.html#module-sphinx.ext.mathjax
154154

155155

156-
.. warning::
157-
158-
You shouldn't modify the following three settings (api_host, project, version) unless you know what you are doing.
159-
Their defaults should be fine to build the documentation and make it work in Read the Docs.
160-
161-
162156
.. confval:: hoverxref_api_host
163157

164158
Description: Host URL for the API to retrieve the content of the floating window
165159

160+
.. warning::
161+
162+
You shouldn't modify this setting unless you know what you are doing.
163+
Its default should be fine to build the documentation and make it work in Read the Docs.
164+
166165
Default: ``https://readthedocs.org``
167166

168167
Type: string

docs/development.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ To make the extension to work, you will need to define this setting in your ``co
8282

8383
.. code-block:: python
8484
85-
hoverxref_api_host = 'http://dev.readthedocs.io:8000'
85+
hoverxref_api_host = 'http://community.dev.readthedocs.io'
8686
8787
.. tip::
8888

docs/usage.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ and will embed the content of the document/section the link is pointing to, into
77

88
``:hoverxref:`` role uses Sphinx's internals reference resolution to find out where the link points to.
99
So, the way of referencing the section works in the same way as the ``:ref:`` standard role.
10-
See :ref:`Sphinx's ref role documentation <sphinx:ref-role>` for more information.
10+
See Sphinx's :rst:role:`ref` for more information.
1111

1212
Simplest usage example,
1313

0 commit comments

Comments
 (0)