-
Notifications
You must be signed in to change notification settings - Fork 155
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
Conversation
38b41c2
to
ebd0116
Compare
@rkratky - thanks for this! I haven't reviewed the content too closely, just looking at CI as of yet, will look at content later. 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 |
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. |
There was a problem hiding this 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.
doc/reuse/links.txt
Outdated
@@ -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 |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this 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.
ebd0116
to
fefbe90
Compare
@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. |
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. |
fefbe90
to
7b1f0c1
Compare
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.