阅读文档托管文档的示例

给你的斯芬克斯文档充电,给你的读者留下深刻印象

我们强大的Sphinx主机为与您的文档交互的每个人提供了阅读和创作体验。

创建帐户 开始我们的教程

与展开预览协作

接收团队的反馈,对变化充满信心在他们上线之前。

总是找到你需要的

使用我们的Search-as-you-type界面搜索所有项目,并快速找到所需的文档和API参考信息。永远不要再丢失文档.

通过链接预览保持关注

使用即时预览链接为文档中的每个内部链接提供上下文。浏览内容而不打开另一个选项卡.

试试看

使用阅读文档升级文档

.读取文档.yaml
版本: 2
建造:
  操作系统: ubuntu-22.04号机组
  工具:
    蟒蛇: "3.10"
    #还可以指定其他工具版本:
    #节点数:“16”

#使用Sphinx在docs/目录中构建文档
狮身人面像:
   配置: 文档/conf.py

#构建文档所需的依赖项
蟒蛇:
   安装:
   - 要求: docs/requirements.txt文件
创建帐户 注册使用GitHub或您的电子邮件。 导入您的项目使用单击界面选择现有Git存储库。 添加YAML配置复制这个例子,它可能会达到你想要的效果😉 您的文档基于每次提交像魔法一样。

5分钟内在线获取您的文档。

创建帐户