首页 > 解决方案 > 由cookicutter文件夹混淆制作的Django sphinx文档

问题描述

在使用 cookiecutter 开始一个全新的 Django 项目时,我对 sphinx 为其文档制作的文件夹结构感到有些困惑。根据说明,我在 docker 中设置了我的项目,一切正常,并且我有以下文档文件夹结构。

启动时创建的文件夹结构

当我make html在 docs 容器中运行命令时(或使用 docker-compose local.yml 文件),我得到以下结构。

之后的文件夹结构

创建了一个新文件夹“html”,其中包含周围文件夹中的所有内容。这个对吗?我是否正确理解了这个过程?对我来说,某处的某些源文件夹看起来有些糟糕的设置。

我是一位经验丰富的 python 开发人员,也熟悉 Docker,但我对 Django 和 sphinx 还很陌生。有人可以指导我正确的道路,可能分享他们的 Django sphinx docs 工作流程吗?

非常感谢。

标签: djangodockerdocumentationpython-sphinxcookiecutter-django

解决方案


推荐阅读