本主题结构#

文档位置和结构#

本主题的文档位于 docs/ 文件夹中。它被构建为一个 Sphinx 文档站点。内容以 reStructuredText 和 MyST Markdown 的组合形式编写。

CSS/JS 资源的位置和结构#

本主题的 CSS 和 JS 是使用 webpacksrc/pydata_sphinx_theme/assets/* 构建到浏览器中。主要入口点是

  • CSS: src/pydata_sphinx_theme/assets/styles/pydata-sphinx-theme.scss

  • JS: src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js

    • 提供附加的 Bootstrap 功能,以及一些自定义导航行为

  • webpack: webpack.config.js

    • 捕获将 src/pydata_sphinx_theme/assets/* 中的 JS 和 CSS 源文件转换为 src/theme/pydata_sphinx_theme/static/ 中的生产资源的技术