我可以使用Sphinx在Django项目中写我的帮助文档

Question

我有一个django项目，一个菜单选项是'Help'。帮助文档是使用Sphinx编写的，页面很多，例如索引，简介，第一视图，用户，词汇表。

我已经使用了html：

<li><a href="help" target="_blank">Help</a></li>

我的网址和视图是：

urls.py

urlpatterns = [
                url(r'^help/', views.index, name='index'),
              ]

views.py：

def index(request):
    context = {}
    url = 'help/index.html'
    return render(request, url, context)

这将使我从菜单进入帮助索引页面，但是我在文档页面中单击的每个链接都会重新引导我通过视图中的索引，并重新显示索引页面，而不是显示我请求的链接。

如果直接在浏览器中显示索引页，而不使用django站点，它将按预期工作。

我不愿意将帮助子系统集成到django中，因为每次我'制作html'时都会被覆盖。

我应该采取什么方法？

Answer 1

我正在使用的一种折衷方法是在urls.py中的帮助文档中为每个页面创建一个条目，并在view.py中创建一个相应的条目，因此

urls.py

urlpatterns = [
                url(r'^help/first_view', views.first_view, name='first_view'),
                url(r'^help/glossary', views.glossary, name='glossary'),
                url(r'^help/', views.index, name='index'),
              ]

views.py

def index(request):
    context = {}
    url = 'help/index.html'
    return render(request, url, context)


def first_view(request):
    context = {}
    url = 'help/first_view.html'
    return render(request, url, context)


def glossary(request):
    context = {}
    url = 'help/glossary.html'
    return render(request, url, context)

我已经写了一个脚本来更新'make html'之后的html页面，以指向相关的CSS和图像文件。