Skip to content

Extend hoverxref_roles to custom crossrefs (#4495) #4563

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 1, 2020
Merged

Extend hoverxref_roles to custom crossrefs (#4495) #4563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1bfbcc6
Extend hoverxref_roles to custom crossrefs (#4495)
willbeaufoy May 10, 2020
898bdd3
Update docs README with build instructions using tox
willbeaufoy May 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,12 @@ There is a way to recreate the doc automatically when you make changes, you
need to install watchdog (``pip install watchdog``) and then use::

make watch

Alternative method using tox
----------------------------

To compile the documentation to HTML run the following command::

tox -e docs

Documentation will be generated (in HTML format) inside the ``.tox/docs/tmp/html`` dir.
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,3 +300,4 @@
"mod": "tooltip",
"ref": "tooltip",
}
hoverxref_roles = ['command', 'reqmeta', 'setting', 'signal']