diff --git a/custom_conf.py b/custom_conf.py index 6f5e362..ec6f6f0 100644 --- a/custom_conf.py +++ b/custom_conf.py @@ -110,7 +110,18 @@ # Links to ignore when checking links linkcheck_ignore = [ - 'http://127.0.0.1:8000' + 'http://127.0.0.1:8000', + r'https://app\.diagrams\.net.*', # ignore, as works in browser, but link checker has some issues + 'https://archive.ph/CAqQm', # ignore, as works in browser, but link checker has some issues + 'https://bazaar.launchpad.net/lp-production-config', # private + 'https://bazaar.staging.launchpad.net', # broken, unclear why XXX 2023-10-14: jugmac00- check with team + 'https://bugs.launchpad.net/charm-launchpad-buildd-image-modifier', # private + 'https://bugs.launchpad.net/launchpad-vbuilder-manage', # private + 'https://launchpad.net/canonical-mojo-specs', # private + r'https://launchpad\.test.*', # ignore, local test setup + 'https://wiki.canonical.com/InformationInfrastructure/OSA/LaunchpadRollout#Config-only_Rollouts', # private + 'https://wiki.canonical.com/Launchpad/FreshLogs', # private + 'https://wiki.canonical.com/Launchpad/SupportRotation#Builder', # private ] # Pages on which to ignore anchors diff --git a/explanation/pip.rst b/explanation/pip.rst index 1481ca7..45c2cd4 100644 --- a/explanation/pip.rst +++ b/explanation/pip.rst @@ -175,8 +175,8 @@ a dependency, upgrading a dependency, adding a script, adding an arbitrary file, and working with unreleased packages. .. _`Zope Toolkit`: https://github.com/zopefoundation/zopetoolkit -.. _`requirements file`: https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format -.. _`constraints file`: https://pip.pypa.io/en/stable/user_guide/#constraints-files +.. _`requirements file`: https://pip.pypa.io/en/stable/reference/requirements-file-format/ +.. _`constraints file`: https://pip.pypa.io/en/stable/reference/requirement-specifiers/ Add a Package ============= @@ -284,7 +284,7 @@ Let's suppose that we want to add the "lazr.foo" package as a dependency. change in version number, or else very bad inconsistencies and confusion across build environments will happen. -.. _`requirements specifiers`: https://pip.pypa.io/en/stable/reference/pip_install/#requirement-specifiers +.. _`requirements specifiers`: https://pip.pypa.io/en/stable/reference/requirement-specifiers/ .. _upgrade-package: diff --git a/how-to/contributing-changes.rst b/how-to/contributing-changes.rst index 5fb126d..75592e3 100644 --- a/how-to/contributing-changes.rst +++ b/how-to/contributing-changes.rst @@ -11,9 +11,9 @@ To begin with, it is usually helpful to discuss the change you'd like to make, in a `bug`_, in the `launchpad-users`_, or `launchpad-dev`_ mailing lists, or on IRC (``#launchpad-dev`` on ``irc.libera.chat``). -.. _bug: -.. _launchpad-users: -.. _launchpad-dev: +.. _bug: https://bugs.launchpad.net/launchpad +.. _launchpad-users: https://launchpad.net/~launchpad-users +.. _launchpad-dev: https://launchpad.net/~launchpad-dev Get the Launchpad source ---------------------------- @@ -36,7 +36,7 @@ Create a branch from a reasonable point, such as ``master``. Make your changes on the branch. Be sure to test them locally by setting up a local `Launchpad development instance`_. -.. _Launchpad development instance: +.. _Launchpad development instance: https://launchpad.readthedocs.io/en/latest/how-to/running.html Run the pre-commit hook ----------------------- @@ -45,8 +45,8 @@ If you followed the instructions to `set up and run Launchpad`_, you should already have ``pre-commit`` installed and have the ``pre-commit`` git hook `installed`_. If not, complete these steps before proceeding. -.. _set up and run Launchpad: -.. _installed: +.. _set up and run Launchpad: https://launchpad.readthedocs.io/en/latest/how-to/running.html +.. _installed: https://launchpad.readthedocs.io/en/latest/how-to/running.html#installing-the-pre-commit-hook Push your changes -------------------- diff --git a/how-to/land-update-for-loggerhead.rst b/how-to/land-update-for-loggerhead.rst index 135e086..792ffea 100644 --- a/how-to/land-update-for-loggerhead.rst +++ b/how-to/land-update-for-loggerhead.rst @@ -2,7 +2,7 @@ Landing updates for Loggerhead ============================== `Loggerhead `_ is a web-based -`Bazaar `_ code browser. +`Bazaar `_ code browser. Landing changes for Loggerhead itself ------------------------------------- @@ -20,6 +20,10 @@ Landing changes in Launchpad itself Performing QA ------------- +.. The following link does not work. + +.. XXX 2023-10-14: jugmac00 - need to verify whether it should actually work + After the changes have landed and passed through buildbot, they will be available at https://bazaar.staging.launchpad.net. diff --git a/reference/python.rst b/reference/python.rst index e3a76ab..77ccd0c 100644 --- a/reference/python.rst +++ b/reference/python.rst @@ -24,7 +24,7 @@ Note that our standards differ slightly from PEP-8 in some cases. Coding standards other projects use: * `Twisted Coding Standard - `_ + `_ * `Zope developer guidelines `_ @@ -84,7 +84,7 @@ indentation rules that implies) so that tools such as `pydoctor API documentation. You should use field names as defined in the `epydoc -`_ documentation but with reST +`_ documentation but with reST syntax. Using \`name\` outputs a link to the documentation of the named object, if diff --git a/reference/services/build-farm.rst b/reference/services/build-farm.rst index 23c3b38..a770b1a 100644 --- a/reference/services/build-farm.rst +++ b/reference/services/build-farm.rst @@ -161,4 +161,4 @@ More information ---------------- * `Live overview of Launchpad's build farm `_ -* `Launchpad services diagram `_ +* `Launchpad services diagram `_ diff --git a/reference/services/signing.rst b/reference/services/signing.rst index cdeff87..aa430b2 100644 --- a/reference/services/signing.rst +++ b/reference/services/signing.rst @@ -63,4 +63,4 @@ Common support cases More information ---------------- -`Launchpad services diagram `_ +`Launchpad services diagram `_ diff --git a/reference/tests.rst b/reference/tests.rst index a597641..9eebee0 100644 --- a/reference/tests.rst +++ b/reference/tests.rst @@ -92,7 +92,7 @@ The basic conventions for testable documentation are: * You can use regular Python comments for explanations related to the code and not to the documentation. * Doctests use Restructured Text (or "ReST", see - http://docutils.sourceforge.net/docs/user/rst/quickref.html). + https://docutils.sourceforge.net/docs/user/rst/quickref.html). * We use ReST because it's what the Python community have standardized on and because it makes setting up Sphinx to browse all the doctests