Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Adopt Docs Starter Pack config #1822

Merged
merged 1 commit into from
Oct 6, 2023
Merged

Conversation

rkratky
Copy link
Collaborator

@rkratky rkratky commented Oct 5, 2023

Fixes FR-5577.

This puts in place the same Read the Docs and Sphinx config as used by the https://github.com/canonical/sphinx-docs-starter-pack, which will make maintenance and upgrades easier.

@dbungert
Copy link
Collaborator

dbungert commented Oct 5, 2023

@rkratky - thanks for this!

I haven't reviewed the content too closely, just looking at CI as of yet, will look at content later.
The new test is failing, I'll let you consider what's going on there.

CLA check is also failing - https://github.com/canonical/subiquity/actions/runs/6422328325/job/17438594649?pr=1822#step:2:50 - I usually suggest using the @canonical email address, which should address this.

@rkratky
Copy link
Collaborator Author

rkratky commented Oct 5, 2023

Yeah. I forgot the CLA, but that's taken care of now. I'll need to look more closely at why the docs checks are failing.

Copy link
Collaborator

@dbungert dbungert left a comment

Choose a reason for hiding this comment

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

This looks mostly fine when the doccheck is fixed (I love the dead link checker), one question though.

@@ -0,0 +1,4 @@
.. _reStructuredText style guide: https://canonical-documentation-with-sphinx-and-readthedocscom.readthedocs-hosted.com/style-guide/
.. _Read the Docs at Canonical: https://library.canonical.com/documentation/read-the-docs
.. _How to publish documentation on Read the Docs: https://library.canonical.com/documentation/publish-on-read-the-docs
Copy link
Collaborator

Choose a reason for hiding this comment

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

I presume library.canonical.com is not accessible to community contributors, is that correct?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Goog point. I'll remove those.

Copy link
Collaborator

@Chris-Peterson444 Chris-Peterson444 left a comment

Choose a reason for hiding this comment

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

This looks good! Thanks @rkratky

Also just one question from me.

@rkratky
Copy link
Collaborator Author

rkratky commented Oct 6, 2023

@dbungert Could you please approve now that the Subiquity checks have passed?

I'll need to work on the docs checks, but it will take a bit more time. Two of them are failing to run, so I need to find out why. The third one (linkcheck) is failing because of, well, invalid links -- so I'll submit another PR to fix them.

@dbungert
Copy link
Collaborator

dbungert commented Oct 6, 2023

I'll need to work on the docs checks, but it will take a bit more time. Two of them are failing to run, so I need to find out why. The third one (linkcheck) is failing because of, well, invalid links -- so I'll submit another PR to fix them.

I think the linkcheck links are failing on the manpages, can you confirm? We were purposefully using links that are redirecting to the latest series, does linkcheck not like those? Those links do work if I click them.

@dbungert dbungert merged commit b1e08b5 into canonical:main Oct 6, 2023
9 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants