Skip to content

fix: exclude readme.rst from rendered page and skip Sphinx venv generation#208

Open
himax16 wants to merge 2 commits into
canonical:mainfrom
himax16:main
Open

fix: exclude readme.rst from rendered page and skip Sphinx venv generation#208
himax16 wants to merge 2 commits into
canonical:mainfrom
himax16:main

Conversation

@himax16

@himax16 himax16 commented Jun 2, 2026

Copy link
Copy Markdown
Member

Exclude readme.rst from rendered file list and stop Sphinx venv rebuild when configuration files are changed as the CI is no longer maintained.

@NickVolynkin NickVolynkin Jun 5, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

v4 is outdated and generates errors in the output log. It's unrelated to linkcheck errors, but as you're already changing this file, you can fix it along the way.

Suggested change
uses: actions/checkout@v6

@NickVolynkin

Copy link
Copy Markdown
Contributor

@himax16 I believe the root problem with this link is that the README file is rendered as a documentation page. I doubt that it really should. See on preview: https://canonical-openstack--208.com.readthedocs.build/en/208/readme/.

If you agree that it should not, you can exclude it as I did here: https://github.com/canonical/canonical-openstack-docs/pull/210/changes#r3361352344

@himax16 himax16 changed the title fix: add ignored link for linkcheck fix: exclude readme.rst from rendered page and skip Sphinx venv generation Jun 5, 2026
himax16 added 2 commits June 5, 2026 17:06
Signed-off-by: Himawan Winarto <himawan.winarto@canonical.com>
…are updated

Signed-off-by: Himawan Winarto <himawan.winarto@canonical.com>
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.

2 participants