You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This issue should be closed when all non xreffed duplication is gone from the docs. When I remove duplicates I'll reference this issue in the commit.
As an example, there are 3 mentions of netrc in the documentation which could be culled and replaced with one xref that displays like this if we install the sphinx-hoverxref role for the docs.
Example from Sphinx official docs
In this example, the word Markdown is written in the .rst file as referencing another .rst file in the doctree. So it renders the actual page for the referenced document and displays it in a nice popup. This should be done for all things that are significant that currently seem to have duplicate mentions. Duplicate mentions implies significance, so those things, whatever they may be should get their own doc file and be referenced like this to avoid fragmentation.
:ref:`Markdown <intro/getting-started-with-sphinx:Using Markdown with Sphinx>`
Turns out that we cannot use sphinx-hoverxref which implements the nice popup and interlinking between sections due to readthedocs/sphinx-hoverxref#69
There is a note that states the following on the sphinx-hoverxref documentation index:
Warning
This extension requires a backend server to retrieve the tooltip content. Currently only Read the Docs is supported, so it will only work if your documentation is hosted on Read the Docs.
xref = cross-reference
This issue should be closed when all non xreffed duplication is gone from the docs. When I remove duplicates I'll reference this issue in the commit.
As an example, there are 3 mentions of
netrc
in the documentation which could be culled and replaced with one xref that displays like this if we install thesphinx-hoverxref
role for the docs.Example from Sphinx official docs
In this example, the word
Markdown
is written in the.rst
file as referencing another.rst
file in the doctree. So it renders the actual page for the referenced document and displays it in a nice popup. This should be done for all things that are significant that currently seem to have duplicate mentions. Duplicate mentions implies significance, so those things, whatever they may be should get their own doc file and be referenced like this to avoid fragmentation.:ref:`Markdown <intro/getting-started-with-sphinx:Using Markdown with Sphinx>`
The source for this example can be found here
The text was updated successfully, but these errors were encountered: