PyMC 网站版本控制#
PyMC 项目有 3 个主要网站与 PyMC 库直接相关。除了像 PyMCon、sprints 或 pymc-experimental 文档这样的更具体的网站外,这些网站还存在。本指南解释了它们之间的关系以及每种网站上应包含的内容类型。
注意
所有3个网站共享相同的导航栏,以向用户展示单一网站的外观,但它们的生成过程彼此完全独立。
在 Home
和 Community
部分下显示的内容是从 pymc.io 的源代码生成的;在 Learn
、API
和 Contributing
部分下显示的内容是从 pymc 的源代码生成的,而 Examples
部分下的内容是从 pymc-examples 生成的。
未版本化的网站是主要的 PyMC 网站,它包含着陆页,并且是 ReadTheDocs 上的父项目。其他两个网站配置为未版本化网站的子项目,这样当我们使用搜索栏时,关键词会在所有三个网站中进行搜索。
未版本化的网站: www.pymc.io
#
我们在 www.pymc.io
发布未版本化的网站。它没有语言或版本指示器。
未版本化的网站是主登录页面,承载与PyMC库或项目相关但不与特定版本绑定的内容。例如PyMC生态系统、社区资源如日历或行为准则以及PyMC博客。
版本化文档: www.pymc.io/projects/docs
#
我们在 www.pymc.io/projects/docs
发布版本化的文档,并附带语言和版本指示符。默认路径为 /en/stable/
。
版本化的文档 与 PyMC 发布同步 ,并包含一些关于核心功能、API 文档和贡献指南的指南。与发布同步意味着我们在 GitHub 上标记的相同代码,以及发布到 PyPI 的代码,用于生成文档。因此,即使 latest
版本随每次提交更新,默认网站 stable
仅在新版本发布时更新。
示例画廊: www.pymc.io/projects/examples
#
我们在以下地址发布示例库:www.docs.pymc.io/projects/examples
加上语言和快照指示符,默认是 /en/latest/
。
我们将定期更新示例库中的笔记本,并在每次提交时将更新发布到示例库网站。我们建议将示例库用作一个无版本的动态资源,但我们也将在每隔几个月提供快照,以满足如需要链接到稳定资源的书籍等需求。
您可以从页面右下角的菜单访问快照。快照的发布时间由 YYYY.0M.MICRO
格式的版本号标识。
Notebooks 被视为博客文章。每个 notebook 的元数据通过标签和分类描述其主题和内容类型以及最后更新日期。我们相信标签和分类简化了导航并提高了效率(与固定的主题划分/层次结构相反)。此外,我们还在页面顶部的导航栏中提供了一个最近更新列表和一个搜索栏。
小心
该网站仍在建设中。因此,并非所有笔记本都已更新以包含所有相关元数据。这些笔记本只能通过搜索栏访问。
分类#
Notebooks 最多有两个类别,一个表示 notebook 的级别,另一个根据 diataxis 框架 表示内容的类型。左侧边栏始终显示所有 7 个类别(3 个级别 + 4 种类型)。您可以点击那里以访问该类别中所有 notebook 的列表页面。如果一个页面在其元数据中包含某些类别,这些类别在类别列表中会以绿色高亮显示。