panel icon indicating copy to clipboard operation
panel copied to clipboard

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

Open Coderambling opened this issue 1 year ago • 0 comments

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?

Coderambling avatar May 15 '24 21:05 Coderambling