Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Eliminate duplication and direct to sphinx-xrefs instead #65

Closed
MatthewCroughan opened this issue Jul 8, 2020 · 3 comments
Closed

Eliminate duplication and direct to sphinx-xrefs instead #65

MatthewCroughan opened this issue Jul 8, 2020 · 3 comments
Assignees
Labels
help wanted Extra attention is needed refactor

Comments

@MatthewCroughan
Copy link
Contributor

MatthewCroughan commented Jul 8, 2020

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 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>`

The source for this example can be found here

Peek 2020-07-07 23-33

@MatthewCroughan MatthewCroughan self-assigned this Jul 15, 2020
@MatthewCroughan MatthewCroughan added help wanted Extra attention is needed refactor labels Jul 15, 2020
@MatthewCroughan
Copy link
Contributor Author

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.

@MatthewCroughan
Copy link
Contributor Author

This issue will see more commits reference it when I start modifying existing content, instead of creating new content as I have been doing lately.

@MatthewCroughan
Copy link
Contributor Author

Issue is not measurable, closing as a result. This serves only as a note and was premature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed refactor
Projects
None yet
Development

No branches or pull requests

1 participant