Skip to content

Conversation

@ashishks0522
Copy link
Collaborator

@ashishks0522 ashishks0522 commented Jan 16, 2026

Add sitemap generation for documentation

Summary

  • Added sphinx-sitemap extension to automatically generate a sitemap for the PennyLane catalyst documentation, improving SEO and to reduce number of 404 pages showing up in Google Console.
  • marks C++ API pages a no-index to prevent C++ pages from getting indexed in Google.

Changes

  • Added sphinx_sitemap to Sphinx extensions in doc/conf.py
  • Updated html_baseurl to use proper canonical URL with ReadTheDocs fallback
  • Added sitemap_url_scheme configuration for standard sitemap format
  • Added sphinx-sitemap dependency to:
    • doc/requirements.txt
    • pyproject.toml (docs optional dependencies)
  • Added add_noindex_to_cpp_pages to exclude C++ API pages

Ticket

Testing

  • Check the sitemap here which includes list of all pages.
  • C++ API pages have noindex nofollow tags to exclude them from Google.
Screenshot 2026-01-16 at 10 20 18 AM

@ashishks0522 ashishks0522 marked this pull request as ready for review January 16, 2026 16:50
@github-actions
Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md on your branch with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

Copy link
Contributor

@doctorperceptron doctorperceptron left a comment

Choose a reason for hiding this comment

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

Should get someone from the Catalyst team (@josh146 or @mlxd?) to approve as well.

@ashishks0522 ashishks0522 requested review from josh146 and mlxd January 16, 2026 19:38
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