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

Auto-generate updated sitemap.xml when site is generated. #6839

Open
Coderambling opened this issue May 15, 2024 · 0 comments
Open

Auto-generate updated sitemap.xml when site is generated. #6839

Coderambling opened this issue May 15, 2024 · 0 comments
Labels
type: docs Related to the Panel documentation and examples

Comments

@Coderambling
Copy link
Contributor

Coderambling commented May 15, 2024

At the moment there is no sitemap.xml for holoviz.org, any of its subdomains, or holoviews.org

An updated sitemap provides a cue to search engines (and AI models?) that a site been updated, and ensures changed / new url's and content are picked up and indexed quickly and regularly by search engines.

https://www.sitemaps.org/protocol.html#index

Possible Sphinx extension candidate:

https://pypi.org/project/sphinx-sitemap/

https://sphinx-sitemap.readthedocs.io/en/latest/getting-started.html

Todo:

-Ascertain how to handle the subdomains of holoviz.org .

Generate one sitemap.xml for each subdomain, and list them in a sitemapindex.xml file?

Can the above software (be made to) handle this for subdomains?

Or is it just a question of configuring conf.py correctly per project / subdomain?

I.e.

Add sphinx_sitemap to extensions in your Sphinx conf.py. For example:

extensions = ['sphinx_sitemap']

Set the value of html_baseurl in your Sphinx conf.py to the current base URL of your documentation. For example:

html_baseurl = 'https://my-site.com/docs/'

sitemap_url_scheme = "{link}"

-Define sitemap exclusions if necessary: a list of url's that should NOT be indexed.

Example: maybe don't include every API technical doc, but only the API index and API search page?

@philippjfr philippjfr added the type: docs Related to the Panel documentation and examples label May 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Related to the Panel documentation and examples
Projects
None yet
Development

No branches or pull requests

2 participants