feat: Enhance ReadTheDocs SEO and discoverability#3
Merged
Conversation
This commit introduces several improvements to the Sphinx documentation
configuration to enhance SEO and site discoverability for the ReadTheDocs site.
Key changes include:
- Added meta descriptions and keywords to `conf.py` using `html_meta`.
- Integrated `sphinx-sitemap` extension to generate a `sitemap.xml`:
- Added `sphinx_sitemap` to `extensions` in `conf.py`.
- Set `html_baseurl` in `conf.py`.
- Added `sphinx-sitemap` to `project.optional-dependencies.docs` in `pyproject.toml`
to ensure it's installed by ReadTheDocs.
- Added JSON-LD structured data to the documentation pages:
- Created `_templates/layout.html` to include a schema.org `TechArticle`
JSON-LD block.
- Updated `templates_path` in `conf.py` to include `_templates`.
These changes will help search engines better understand and index the
documentation content, improving its visibility and accessibility.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit introduces several improvements to the Sphinx documentation configuration to enhance SEO and site discoverability for the ReadTheDocs site.
Key changes include:
conf.pyusinghtml_meta.sphinx-sitemapextension to generate asitemap.xml:sphinx_sitemaptoextensionsinconf.py.html_baseurlinconf.py.sphinx-sitemaptoproject.optional-dependencies.docsinpyproject.tomlto ensure it's installed by ReadTheDocs._templates/layout.htmlto include a schema.orgTechArticleJSON-LD block.templates_pathinconf.pyto include_templates.These changes will help search engines better understand and index the documentation content, improving its visibility and accessibility.