PyMC 网站版本控制#
PyMC 项目有 3 个主要网站直接与 PyMC 库相关。 这些网站是 pymc-experimental 的 PyMCon、sprints 或文档等更具体网站的补充。 本指南解释了它们之间的关系以及每种网站应包含的内容类型。
注意
所有 3 个网站共享相同的导航栏,以便给用户提供单个网站的外观,但它们的生成过程彼此完全独立。
在 Home
和 Community
部分下显示的内容是从 pymc.io 的源生成的;在 Learn
、API
和 Contributing
下显示的内容是从 pymc 的源生成的,而在 Examples
下的内容是从 pymc-examples 生成的。
未版本控制的网站是主要的 PyMC 网站,它包含着陆页,并且是 ReadTheDocs 上的父项目。 其他两个网站配置为未版本控制网站的子项目,以便当我们使用搜索栏时,关键字会在所有 3 个网站中搜索。
未版本控制的网站: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
格式的版本号标识快照发布的时间。
笔记本被视为博客文章。 每个笔记本的元数据通过标签和类别以及上次更新日期描述其主题和内容类型。 我们认为标签和类别简化并改进了导航(而不是固定的主题划分/层次结构)。 此外,我们还在页面顶部的导航栏中提供了最近更新列表和搜索栏。
注意
该网站仍在建设中。 因此,并非所有笔记本都已更新以包含所有相关的元数据。 这些笔记本只能从搜索栏访问。
类别#
笔记本最多有两个类别,一个指示笔记本的级别,另一个根据 diataxis 框架指示内容类型。 左侧边栏始终显示所有 7 个类别(3 个级别 + 4 种类型)。 您可以单击此处访问列出该类别中所有笔记本的页面。 如果页面在其元数据中包含某些类别,则这些类别在类别列表中以绿色突出显示。