Browse Source

Update user guide with Sphinx docs info (#4554)

John Arnold 7 years ago
parent
commit
59ab9d93f4
2 changed files with 17 additions and 0 deletions
  1. 1 0
      docs/userguide/index.rst
  2. 16 0
      docs/userguide/sphinx.rst

+ 1 - 0
docs/userguide/index.rst

@@ -27,3 +27,4 @@
     testing
     extending
     configuration
+    sphinx

+ 16 - 0
docs/userguide/sphinx.rst

@@ -0,0 +1,16 @@
+.. _sphinx:
+
+==============================
+ Documenting Tasks with Sphinx
+==============================
+
+This document describes how auto-generate documentation for Tasks using Sphinx.
+
+
+--------------------------------
+ celery.contrib.sphinx
+--------------------------------
+
+.. automodule:: celery.contrib.sphinx
+    :members:
+    :noindex: