Install intersphinx extension and edit links

Some anchor links are currently lost on:

* developer/system/template-manager.rst
* user/how-to-guides/how-to-enter-fullscreen-mode.rst
This commit is contained in:
parulin 2025-09-13 04:30:59 -04:00
parent c9ee35aa07
commit c40c0ac302
No known key found for this signature in database
GPG key ID: 65099A5B0E31336C
5 changed files with 12 additions and 9 deletions

View file

@ -31,6 +31,7 @@ release = '4.2.4'
extensions = [ extensions = [
'sphinx.ext.autosectionlabel', # Automatically generate section labels 'sphinx.ext.autosectionlabel', # Automatically generate section labels
'sphinx.ext.intersphinx', # Reference other doc projects
'sphinxnotes.strike', # Add strike-through text support 'sphinxnotes.strike', # Add strike-through text support
'sphinx_reredirects', # Manage redirects in the documentation 'sphinx_reredirects', # Manage redirects in the documentation
'sphinxext.opengraph', # Add Open Graph meta tags for social media sharing 'sphinxext.opengraph', # Add Open Graph meta tags for social media sharing
@ -49,7 +50,6 @@ redirects = {
"https://www.qubes-os.org/downloads/", "https://www.qubes-os.org/downloads/",
} }
# -- -- Options for highlighting --------------------------------------------- # -- -- Options for highlighting ---------------------------------------------
# Disable syntax highlighting # Disable syntax highlighting
@ -101,6 +101,12 @@ linkcheck_ignore = [r'^https?://[^/\s]+\.onion']
# Prefix section labels with the document name # Prefix section labels with the document name
autosectionlabel_prefix_document = True autosectionlabel_prefix_document = True
# Allows references to the docs in dev.qubes-os.org
intersphinx_mapping = {
'core-admin': ('https://dev.qubes-os.org/projects/core-admin/en/latest/', None),
'core-admin-client': ('https://dev.qubes-os.org/projects/core-admin-client/en/latest/', None),
}
# Open Graph image for social media sharing # Open Graph image for social media sharing
ogp_image = "https://www.qubes-os.org/attachment/icons/qubes-logo-icon-name-slogan-fb.png" ogp_image = "https://www.qubes-os.org/attachment/icons/qubes-logo-icon-name-slogan-fb.png"
# Disable Open Graph image alt text # Disable Open Graph image alt text

View file

@ -23,7 +23,7 @@ Modifying the NIC of the target VM
---------------------------------- ----------------------------------
You will need to create a custom libvirt config for the target VM. See `the documentation <https://dev.qubes-os.org/projects/core-admin/en/latest/libvirt.html>`__ for overview of how libvirt templates work in Qubes. The following assumes the target VM is named ``target-vm``. You will need to create a :external:doc:`custom libvirt config <libvirt>` for the target VM. The following assumes the target VM is named ``target-vm``.
- Edit ``/usr/share/qubes/templates/libvirt/xen.xml`` to prepare our custom config to override just the NIC part of the global template: - Edit ``/usr/share/qubes/templates/libvirt/xen.xml`` to prepare our custom config to override just the NIC part of the global template:

View file

@ -83,7 +83,7 @@ The file structure should be quite similar to previous template RPMs. Namely, th
- Uses ``KEY=VALUE`` format. - Uses ``KEY=VALUE`` format.
- Fields (corresponding to `qvm-prefs <https://dev.qubes-os.org/projects/core-admin-client/en/stable/manpages/qvm-prefs.html#common-properties>`__ and `qvm-features <https://dev.qubes-os.org/projects/core-admin-client/en/stable/manpages/qvm-features.html#list-of-known-features>`__ tags with the same names) - Fields (corresponding to :external:doc:`qvm-prefs <manpages/qvm-prefs>` and :external:doc:`qvm-features <manpages/qvm-features>` tags with the same names)
- ``virt_mode`` - ``virt_mode``

View file

@ -51,7 +51,7 @@ Enabling fullscreen mode from a selected qube
.. warning:: Be sure to read :ref:`secure-use-of-fullscreen-mode` first. .. warning:: Be sure to read :ref:`secure-use-of-fullscreen-mode` first.
As an alternative to the Xfce4 method, you can enable fullscreen mode for selected qubes by using the `gui-allow-fullscreen <https://dev.qubes-os.org/projects/core-admin-client/en/latest/manpages/qvm-features.html#gui-gui-default>`__ feature of a qube. As an alternative to the Xfce4 method, you can enable fullscreen mode for selected qubes by using the :external:doc:`gui-allow-fullscreen <manpages/qvm-features>` feature of a qube.
Be sure to restart the qube after modifying this feature, for the changes to take effect. Be sure to restart the qube after modifying this feature, for the changes to take effect.

View file

@ -7,11 +7,8 @@ Dom0
---- ----
- `core-admin <https://dev.qubes-os.org/projects/core-admin/en/latest/manpages/>`__ - :external+core-admin:doc:`core-admin <manpages/index>`
- :external+core-admin-client:doc:`core-admin-client <manpages/index>`
- `core-admin-client <https://dev.qubes-os.org/projects/core-admin-client/en/latest/manpages/>`__
DomU DomU
---- ----