可访问性

创造和发布不排斥各种能力有限的受众的内容是一项挑战，但实现并维持这一目标也很重要。

虽然没有万无一失的解决方案来维护可访问的内容，但这个主题和文档站点使用了一些技术来避免常见的内容缺陷。

备注

Issue 和 PR，以确定或修复这个主题或网站的可访问性问题，我们衷心欢迎！

在配置中

网站 conf.py 中的一些小配置选项可能会影响由该主题生成的内容的可访问性，以及 Sphinx 的一般情况。

自然语言

如果没有使用更健壮的 国际化方法，至少指定基线自然语言将有助于辅助技术识别内容是否使用读者理解的语言。

提示

指定 language 将传播到顶级 html tag。

language = "en"

站点地图

站点地图通常由名为 sitemap.xml 的文件提供，它是一种广泛应用的方法，可以告诉搜索引擎和辅助技术等程序不同的内容出现在网站的哪个位置。

如果使用服务像 ReadTheDocs，这些文件将自动为您创建，但对于一些下面的其他方法，它是方便的在本地生成 sitemap.xml 或在 CI 工具像 sphinx-sitemap.”。

提示

对于简单的站点（没有额外的语言或版本），确保 sphinx-sitemap 安装在您的文档环境中，并修改您的 conf.py：

extensions += ["sphinx_sitemap"]

html_baseurl = os.environ.get("SPHINX_HTML_BASE_URL", "http://127.0.0.1:8000/")
sitemap_locales = [None]
sitemap_url_scheme = "{link}"

源码中

备注

在我们了解更多关于这个网站的工作时，请继续关注这里的更多想法！

浏览器中

有许多浏览器内的工具可以交互地一次调试单个页面的可访问性，在内容开发周期中非常有用。

内建工具

大多数主流浏览器，包括 Firefox 和 Chrome 在他们的开发经验中包括重要的可访问性工具。探索这些以及它们所提供的模式，可以帮助你快速找出问题所在，而且通常还会包含标准链接。

tota11y

tota11y 是开源的 “bookmarklet”，它修改了当前加载的页面，并高亮了许多可访问性问题。

WAVE

WAVE 是专有的（但 免费）浏览器插件，可以高亮显示大量的问题。

在持续集成

有很多自动化工具可以一次性评估多个页面的易访问性问题，通常有很多可配置的选项。

Lighthouse

Lighthouse, which provides automated assessment of basic accessibility issues in addition to search engine automation, page performance, and other best practices.

提示

Specifically, foo-software/lighthouse-check-action is run on selected pages from the generated documentation site.