Add sitemap

[haesleinhuepf]

Tgus repository contains a jupyter book in the "docs" folder that is rendered automatically to a github.io website. How can we add a sitemap to make our contents discoverable by search engines?

Git-bob comment

[github-actions]

^{This message was generated by git-bob (version: 0.14.0, model: github_models:gpt-4o, log), an experimental AI-based assistant. It can make mistakes and has limitations. Check its messages carefully.}

To add a sitemap to your Jupyter Book, you can use the sphinx-sitemap extension. Here’s how you can integrate it into your current configuration:

1. Install the sphinx-sitemap package via pip if you haven't yet:

   pip install sphinx-sitemap

2. Update your _config.yml to include the extension and set the necessary configuration. Add the sitemap info under sphinx.config:

   sphinx:
     config:
       html_show_copyright: false
       html_last_updated_fmt: '%Y-%m-%d'
       extensions:
         - sphinx_sitemap
       sitemap_url_scheme: "{link}"
       site_url: "https://yourwebsite.github.io/"

   Replace "https://yourwebsite.github.io/" with the actual URL where your Jupyter Book is hosted.

This will create a sitemap.xml file in your build directory that you can submit to search engines for better discoverability.

[haesleinhuepf]

The site_url is "https://nfdi4bioimage.github.io/training" and you can add the new dependency to the requirements.txt

git-bob implement this