Skip to content

Commit

Permalink
Run link checker and apply fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jugmac00 committed Oct 14, 2023
1 parent 9ea36dc commit ce05d64
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 16 deletions.
13 changes: 12 additions & 1 deletion custom_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions explanation/pip.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
=============
Expand Down Expand Up @@ -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:

Expand Down
12 changes: 6 additions & 6 deletions how-to/contributing-changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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: <https://bugs.launchpad.net/launchpad>
.. _launchpad-users: <https://launchpad.net/~launchpad-users>
.. _launchpad-dev: <https://launchpad.net/~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
----------------------------
Expand All @@ -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: <https://launchpad.readthedocs.io/en/latest/how-to/running.html>
.. _Launchpad development instance: https://launchpad.readthedocs.io/en/latest/how-to/running.html

Run the pre-commit hook
-----------------------
Expand All @@ -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: <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>
.. _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
--------------------
Expand Down
6 changes: 5 additions & 1 deletion how-to/land-update-for-loggerhead.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Landing updates for Loggerhead
==============================

`Loggerhead <https://launchpad.net/loggerhead/>`_ is a web-based
`Bazaar <https://bazaar.canonical.com/>`_ code browser.
`Bazaar <https://en.wikipedia.org/wiki/GNU_Bazaar>`_ code browser.

Landing changes for Loggerhead itself
-------------------------------------
Expand All @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions reference/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Note that our standards differ slightly from PEP-8 in some cases.
Coding standards other projects use:

* `Twisted Coding Standard
<https://twistedmatrix.com/documents/current/core/development/policy/coding-standard.html>`_
<https://docs.twistedmatrix.com/en/stable/development/coding-standard.html>`_
* `Zope developer guidelines
<https://www.zope.org/developer/guidelines.html>`_

Expand Down Expand Up @@ -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
<http://epydoc.sourceforge.net/fields.html>`_ documentation but with reST
<https://epydoc.sourceforge.net/fields.html>`_ documentation but with reST
syntax.

Using \`name\` outputs a link to the documentation of the named object, if
Expand Down
2 changes: 1 addition & 1 deletion reference/services/build-farm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,4 +161,4 @@ More information
----------------

* `Live overview of Launchpad's build farm <https://launchpad.net/builders>`_
* `Launchpad services diagram <https://viewer.diagrams.net/?tags=%7B%7D&highlight=0000ff&edit=_blank&layers=1&nav=1&page-id=14glVH8XSJX-2FxTRWny#G1j-yk3c4mzYfMC79Y-uo9__u93pLWkiMi>`_
* `Launchpad services diagram <https://app.diagrams.net/?src=about#Uhttps%3A%2F%2Fgit.launchpad.net%2Flaunchpad%2Fplain%2Fdoc%2Fdiagrams%2Farchitecture.html#%7B%22pageId%22%3A%2214glVH8XSJX-2FxTRWny%22%7D>`_
2 changes: 1 addition & 1 deletion reference/services/signing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ Common support cases
More information
----------------
`Launchpad services diagram <https://viewer.diagrams.net/?tags=%7B%7D&highlight=0000ff&edit=_blank&layers=1&nav=1&page-id=14glVH8XSJX-2FxTRWny#G1j-yk3c4mzYfMC79Y-uo9__u93pLWkiMi>`_
`Launchpad services diagram <https://app.diagrams.net/?src=about#Uhttps%3A%2F%2Fgit.launchpad.net%2Flaunchpad%2Fplain%2Fdoc%2Fdiagrams%2Farchitecture.html#%7B%22pageId%22%3A%2214glVH8XSJX-2FxTRWny%22%7D>`_
2 changes: 1 addition & 1 deletion reference/tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ce05d64

Please sign in to comment.