Skip to content

Commit

Permalink
Fix invalid links reported by linkcheck.
Browse files Browse the repository at this point in the history
(Introduced the extlinks extension for handling manpage links.)
  • Loading branch information
rkratky committed Oct 19, 2023
1 parent d2637da commit 162a2e9
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 10 deletions.
5 changes: 5 additions & 0 deletions doc/custom_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@
# Add extensions
custom_extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.extlinks'
]

# Add files or directories that should be excluded from processing.
Expand Down Expand Up @@ -172,3 +173,7 @@
# can be copied even if they don't contain an EOF line.
copybutton_prompt_text = '$ '
copybutton_only_copy_prompt_lines = False

extlinks = {
'manualpage': ( 'https://manpages.ubuntu.com/manpages/lunar/en/%s', '' )
}
2 changes: 1 addition & 1 deletion doc/explanation/operate-server-installer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Operating the Server installer

This document explains how to use the installer in general terms. For a
step-by-step guide through the screens of the installer, you can use our
`screen-by-screen reference guide <https://discourse.ubuntu.com/t/draft-using-the-server-installer-step-by-step/16690>`_.
`screen-by-screen reference guide <https://discourse.ubuntu.com/t/screen-by-screen-installer-guide/16690>`_.

Get the installer
=================
Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ constructive feedback.
development/index

.. Links:
.. _Code of Conduct: https://ubuntu.com/community/code-of-conduct
.. _Code of Conduct: https://ubuntu.com/community/ethos/code-of-conduct
.. _Ubuntu Foundations: https://discourse.ubuntu.com/c/foundations/
.. _Libera.Chat: https://libera.chat/
.. _CONTRIBUTING.md: https://github.com/canonical/subiquity/blob/main/CONTRIBUTING.md
10 changes: 4 additions & 6 deletions doc/reference/autoinstall-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,7 @@ installed will not have a keyboard at all in which case the value used here
does not matter.

The mapping's keys correspond to settings in the :file:`/etc/default/keyboard`
configuration file. See
`its manual page <http://manpages.ubuntu.com/manpages/keyboard.5.html>`_
configuration file. See the :manualpage:`keyboard(5) manual page <man5/keyboard.5.html>`
for more details.

The mapping contains keys:
Expand Down Expand Up @@ -635,10 +634,9 @@ password
The password for the new user, encrypted. This is required for use with
``sudo``, even if SSH access is configured.

The crypted password string must conform to what
`passwd <https://manpages.ubuntu.com/manpages/passwd.1.html>`_
expects. Depending on the special characters in the password hash, quoting may
be required, so it's safest to just always include the quotes around the hash.
The crypted password string must conform to what the
``passwd`` command requires. See the :manualpage:`passwd(1) manual page <man1/passwd.1.html>`
for details. Quote the password hash to ensure correct treatment of any special characters.

Several tools can generate the crypted password, such as ``mkpasswd`` from the
``whois`` package, or ``openssl passwd``.
Expand Down
2 changes: 1 addition & 1 deletion doc/tutorial/basic-server-installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Create a bootable USB

There are many ways to boot the installer but the simplest and most common way
is to
`create a bootable USB stick <https://ubuntu.com/tutorials/tutorial-create-a-usb-stick-on-ubuntu>`_
`create a bootable USB stick <https://ubuntu.com/tutorials/create-a-usb-stick-on-ubuntu>`_
to boot the system to be installed with
(`tutorials for other operating systems <https://ubuntu.com/search?q=%22create+a+bootable+USB+stick%22>`_
are also available).
Expand Down
2 changes: 1 addition & 1 deletion doc/tutorial/screen-by-screen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This screen selects the language for the installer and the default language
for the installed system.

More languages can be displayed if you
`connect via SSH <https://discourse.ubuntu.com/t/draft-using-the-server-installer/16689#connect-via-ssh>`_.
`connect via SSH <https://discourse.ubuntu.com/t/how-to-operate-the-server-installer/16689#connect-via-ssh>`_.

Refresh
=======
Expand Down

0 comments on commit 162a2e9

Please sign in to comment.