Skip to content

docs: update sitemap to 2.7.0 and support lastmods#5579

Open
medubelko wants to merge 8 commits intocanonical:mainfrom
medubelko:docs-update-sitemap
Open

docs: update sitemap to 2.7.0 and support lastmods#5579
medubelko wants to merge 8 commits intocanonical:mainfrom
medubelko:docs-update-sitemap

Conversation

@medubelko
Copy link
Contributor

  • Have you followed the guidelines for contributing?
  • Have you signed the CLA?
  • Have you successfully run make lint?
  • Have you successfully run make test?

build:
html:
- make docs UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" DOCS_OUTPUT="$READTHEDOCS_OUTPUT/html/"
- make docs UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" DOCS_OUTPUT="$READTHEDOCS_OUTPUT/html/" GIT_DISCOVERY_ACROSS_FILESYSTEM=1
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mr-cal This brings us to:

Error getting data from Git (no "last updated" dates will be shown for source files from /home/docs/checkouts/readthedocs.org/user_builds/canonical-snapcraft/envs/5579/lib/python3.12/site-packages/craft_parts_docs/craft-parts/explanation):
fatal: not a git repository (or any of the parent directories): .git

The last line is a departure, but I don't know why it's printing .git.

The build is acting like git_exclude_patterns has no effect. I could dig into this further, but I don't know whether it's worth it. The lastmods add a modest amount of value to the sitemap.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I agree that it may not be worth the effort. I'm suspecting this is an upstream issue, as there should be a way to not fail here. Think we should report it upstream?

After looking at the outstanding bugs, I think we should wait on bumping sphinx-sitemap to 2.7. For example, 2.7 includes flask but doesn't use it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Opened an ticket: mgeier/sphinx-last-updated-by-git#83

I agree, let's leave it at 2.6.0 for now. I'll keep this branch up for a while longer.

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