Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

chore: add targets for links from Ops docs #581

Merged
merged 2 commits into from
Mar 4, 2025

Conversation

dwilding
Copy link
Contributor

@dwilding dwilding commented Mar 4, 2025

This PR adds intersphinx targets needed by canonical/operator#1603. We haven't been entirely consistent with - vs _ in targets in Pebble, so I've tried to be as consistent as possible:

  • Use - for title targets
  • Match the format of siblings for section targets

@dwilding dwilding requested a review from benhoyt March 4, 2025 03:30
@benhoyt
Copy link
Contributor

benhoyt commented Mar 4, 2025

Thanks. Currently the docs fail to build:

/home/docs/checkouts/readthedocs.org/user_builds/canonical-pebble/checkouts/581/docs/reference/index.md:33: WARNING: more than one target found for 'myst' cross-reference layer-specification: could be :std:ref:`Layers` or :std:doc:`Layers` [myst.xref_ambiguous]
/home/docs/checkouts/readthedocs.org/user_builds/canonical-pebble/checkouts/581/docs/reference/index.md:34: WARNING: more than one target found for 'myst' cross-reference layer-specification: could be :std:ref:`Layer specification` or :std:doc:`Layer specification` [myst.xref_ambiguous]

@dwilding
Copy link
Contributor Author

dwilding commented Mar 4, 2025

Thanks. Currently the docs fail to build:

/home/docs/checkouts/readthedocs.org/user_builds/canonical-pebble/checkouts/581/docs/reference/index.md:33: WARNING: more than one target found for 'myst' cross-reference layer-specification: could be :std:ref:`Layers` or :std:doc:`Layers` [myst.xref_ambiguous]
/home/docs/checkouts/readthedocs.org/user_builds/canonical-pebble/checkouts/581/docs/reference/index.md:34: WARNING: more than one target found for 'myst' cross-reference layer-specification: could be :std:ref:`Layer specification` or :std:doc:`Layer specification` [myst.xref_ambiguous]

Hmm, I thought I had run the checks locally, but apparently not. Just pushed a fix - we should be good now.

Copy link
Contributor

@benhoyt benhoyt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@benhoyt benhoyt merged commit 8c1fef0 into canonical:master Mar 4, 2025
18 checks passed
@dwilding dwilding deleted the add-intersphinx-targets branch March 4, 2025 04:49
benhoyt added a commit to canonical/operator that referenced this pull request Mar 4, 2025
)

Just update the hard-coded docs links from
https://canonical-pebble.readthedocs-hosted.com/ to
https://documentation.ubuntu.com/pebble/

David also converted the Pebble links to intersphinx where possible.
See also canonical/pebble#581.
---------

Co-authored-by: David Wilding <david.wilding@canonical.com>
benhoyt added a commit to benhoyt/operator that referenced this pull request Mar 5, 2025
…nonical#1603)

Just update the hard-coded docs links from
https://canonical-pebble.readthedocs-hosted.com/ to
https://documentation.ubuntu.com/pebble/

David also converted the Pebble links to intersphinx where possible.
See also canonical/pebble#581.
---------

Co-authored-by: David Wilding <david.wilding@canonical.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants