Geek asks and answers

Django and Sphinx - how to display HTML sphinx?

OK. I have a Django project that I want to document, so I installed Sphinx. Installation went fine, and I can output all the HTML to a folder _build. But...

Question: how do I really view my documentation in a browser?

Is it supposed that the documentation will not be considered in the Django project, but on its own website? If you are viewing a Djano project, do I need to set up a template urlfor processing documentation?

I'm a little confused how to actually view this information in my browser in a Django project.

+3
source share
1 answer
url(r'^docs/(?P<path>.*)$', 'django.views.static.serve', {'document_root': settings.DOCS_ROOT}),
url(r'^docs/', 'django.views.static.serve', {'document_root': settings.DOCS_ROOT, 'path': 'index.html'}),

settings.DOCS_ROOT - docs/_build/html, Sphinx.

: django-docs;)

+3

More articles:


All Articles