Hi @evildmp :wave:
I have a project that does this:
https://noumenal.es/django-sphinx-view/
The tl;dr is:
Use the JSON builder
Have a Django serve the appropriate page.
Permissions isn’t something I’ve explicitly added but It’s Just Django so you’d implement a role check, in a DocumentationVie… Answer from carltongibson on forum.djangoproject.com
GitHub
github.com › sphinx-doc › sphinxcontrib-django
GitHub - sphinx-doc/sphinxcontrib-django: This is a sphinx extension which improves the documentation of Django apps. · GitHub
Cross-reference Django models by their app label with :py:model:, e.g. :py:model:`auth.User` — the same notation used by Django's admindocs ... # Add source directory to sys.path sys.path.insert(0, os.path.abspath("../src")) # Add sphinxcontrib_django to installed extensions extensions = [ "sphinxcontrib_django", ] # Configure the path to the Django settings module django_settings = "myapp.settings"
Author: sphinx-doc
Django Forum
forum.djangoproject.com › using django
Django and Sphinx - Using Django - Django Forum
January 14, 2025 - We’re looking at using Django to serve Sphinx content as static files - the idea at present is to swallow each page, minus the site’s navigation menu, and to have Django render a template with that as the content. The problem we’re trying to solve is granular access control, so that authorised users get to see a subset of pages.
Integrating Sphinx Documentation with django - Stack Overflow
I have created sphinx documentation for a django project. It created a build folder an html folder and an index.html file. What im not to sure about is how to integrate the index.html file into my More on stackoverflow.com
Any suggestions for documenting a Django project? Epydoc? Sphinx?
Sphinx and, specifically, Read the Docs . More on reddit.com
9
9
January 30, 2013Sphinx book in django page, how to connect? - Python - SitePoint Forums | Web Development & Design Community
Hello there! I’m trying to build an interactive book. Currently I’ve built a webpage in django with a user registration system. I’ve also built a basic book using sphinx and the pydata-sphinx-theme. Now my problem is the following, when I ‘make’ the html files from my markdown pages ... More on sitepoint.com
0
April 27, 2023Can I use Sphinx write my help documentation in a django project - Stack Overflow
I have a django project and one menu option is 'Help'. The help documentation is written using Sphinx and there are many pages, e.g. Index, Introduction, First View, Users, Glossary. I have used the More on stackoverflow.com
Hi @evildmp :wave:
I have a project that does this:
https://noumenal.es/django-sphinx-view/
The tl;dr is:
Use the JSON builder
Have a Django serve the appropriate page.
Permissions isn’t something I’ve explicitly added but It’s Just Django so you’d implement a role check, in a DocumentationVie… Answer from carltongibson on forum.djangoproject.com
24:35
Documenting Django Code in 2022 with Eric Holscher - DjangoCon ...
Integrating Sphinx Documentation with django - YouTube
Django : How to build sphinx documentation for django project
- YouTube
36:43
DjangoCon 2021 | Dynamic static sites with Django and Sphinx | ...
01:22:17
Customer Docs - Building SaaS with Python and Django #85 - YouTube
Sphinx
sphinx-doc.org
Sphinx — Sphinx documentation
These sections cover the basics of getting started with Sphinx, including creating and building your own documentation from scratch.
Medium
medium.com › free-code-camp › sphinx-for-django-documentation-2454e924b3bc
How to document your Django project using the Sphinx tool | by Goran Aviani | We’ve moved to freeCodeCamp.org/news | Medium
October 22, 2018 - So today I have made a simple but comprehensive tutorial that explains how to make Django documentation using the Sphinx documentation tool in Ubuntu.
Django Packages
djangopackages.org › packages › p › django-sphinx-hosting
Django Packages : django-sphinx-hosting
Reusable Django app for hosting Sphinx documentation privately.
Django
docs.djangoproject.com › en › dev › internals › contributing › writing-documentation
Writing documentation | Django documentation | Django
Sphinx includes a sphinx-build command for turning reStructuredText into other formats, e.g., HTML and PDF. This command is configurable, but the Django documentation includes a Makefile that provides a shorter make html command.
Columbia University
columbia.edu › ~alan › django-jsonapi-training › sphinx.html
Sphinx Documentation — Django {json:api} training 0.2.3 documentation
To Use sphinx, we’ll install a bunch of packages: # bring in requirements for my app (excepting the optional database): -r../requirements-django.txt # stuff needed for sphinx documentation: Sphinx==1.8.2 sphinx-markdown-tables==0.0.9 sphinx-rtd-theme==0.4.2 sphinxcontrib-apidoc==0.3.0 sphinxcontrib-confluencebuilder==0.9 sphinxcontrib-django==0.4 sphinxcontrib-websupport==1.1.0 recommonmark==0.4.0
Top answer 1 of 2
6
There are some good use cases for integrating sphinx doc into Django:
- Allow for dynamic content within documentation (i.e. user login, current time, etc).
- Integrate the documentation with your overall sitemap.
- Only one set of templates / CSS files to create and maintain.
If you have one or more of these needs, I would take a look at django-sphinxdoc, it handles all basic use cases out of the box but can be easily modified.
2 of 2
2
IMO, the 'best' way to do this is just at the HTTP server level and not in Django itself (at least that's how I've done it in the past). You don't need or want any pieces of Django layer to serve out your sphinx docs, you just need a 'vanilla' web server setup to do that.
Also, this could help Django urls straight to html template if you insist on using Django... but again, I'd vote to just setupt a /docs directory under your root and point it at the sphinx data via basic Apache/NGINX/etc config.
GitHub
github.com › dcramer › django-sphinx
GitHub - dcramer/django-sphinx: A transparent layer for full-text search using Sphinx and Django · GitHub
A transparent layer for full-text search using Sphinx and Django - dcramer/django-sphinx
Author: dcramer
DEV Community
dev.to › doridoro › host-a-django-project-documentation-autogenerated-with-sphinx-on-read-the-docs-django-specifics-121p
Host a Django project documentation autogenerated with Sphinx on Read the Docs -- Django specifics - DEV Community
May 27, 2024 - First, you need to configure Django specific settings within the conf.py file of the Sphinx configuration, create a settings file for important Django settings and after connect your project repository to Read the Docs and configure it to recognize your Sphinx documentation setup.
Django Packages
djangopackages.org › grids › g › documentation
Django Packages : Reusable apps, sites and tools directory for Django
This is a sphinx extension which improves the documentation of Django apps.
Reddit
reddit.com › r/django › any suggestions for documenting a django project? epydoc? sphinx?
r/django on Reddit: Any suggestions for documenting a Django project? Epydoc? Sphinx?
January 30, 2013 -
At work, I have been developing a growing Django-powered site that is a collection of tools that supplement the main content.
Anyway, I'd like to build some documentation to better enable someone else to eventually take over, or if the project continues to grow, even to help me be more efficient.
Up till now, I've just been using lots of inline comments, but I think I'd like to move toward something like epydoc. The ability to click through linked HTML pages describing functionality seems attractive.
Before I get started and become tied to a particular solution, I thought I'd ask for guidance: Is epydoc the right path? I see a lot about Sphinx in my Google searches, but it looks far more complex than my needs.
Also, does anyone know of a good "intro to epydoc" (or their doc generation tool of choice) that can get me on the right path?
Any advice is appreciated.
PyPI
pypi.org › project › django-sphinx-hosting
django-sphinx-hosting · PyPI
This reusable Django application provides models, views, permissions, REST API endpoints and management commands for making a private Sphinx documentation hosting platform.
SitePoint
sitepoint.com › python, perl and golang › python
Sphinx book in django page, how to connect? - Python - SitePoint Forums | Web Development & Design Community
April 27, 2023 - Hello there! I’m trying to build an interactive book. Currently I’ve built a webpage in django with a user registration system. I’ve also built a basic book using sphinx and the pydata-sphinx-theme. Now my problem is the following, when I ‘make’ the html files from my markdown pages in sphinx I get 10+ html files, each file containing (hardcoded) cross references to one of the other files.
GitHub
github.com › carltongibson › django-sphinx-view
GitHub - carltongibson/django-sphinx-view: Django Powered Dynamic Sphinx Docs. · GitHub
Django Powered Dynamic Sphinx Docs. Contribute to carltongibson/django-sphinx-view development by creating an account on GitHub.
Starred by 54 users
Forked by 5 users
Languages: Python 95.2% | HTML 4.8%
PyPI
pypi.org › project › django-sphinx › 2.0.2
django-sphinx · PyPI
An integration layer bringing Django and Sphinx Search together.
» pip install django-sphinx
Stack Overflow
stackoverflow.com › questions › 59020679 › can-i-use-sphinx-write-my-help-documentation-in-a-django-project
Can I use Sphinx write my help documentation in a django project - Stack Overflow
I am loathe to integrate the help sub-system into django, because it would get over-written every time I 'make html'. ... Sphinx generates a static web site, meant to be served directly to user.
Django Documentation
docs.djangoproject.com › en › 5.1 › intro › whatsnext
What to read next | Django documentation | Django
Django’s documentation uses a system called Sphinx to convert from plain text to HTML.
Sphinx
sphinx-doc.org › ja › master › development › html_themes › templating.html
テンプレート — Sphinx documentation
Sphinx uses the Jinja templating engine for its HTML templates. Jinja is a text-based engine, inspired by Django templates, so anyone having used Django will already be familiar with it.