Browse Source

Documentation: Added missing modules to autodoc

Ask Solem 15 years ago
parent
commit
d01ddea318

+ 4 - 1
contrib/release/doc4allmods

@@ -3,7 +3,10 @@
 PACKAGE="$1"
 SKIP_PACKAGES="$PACKAGE tests management urls"
 SKIP_FILES="celery.bin.rst celery.contrib.rst
-            celery.contrib.batches.rst"
+            celery.contrib.batches.rst
+            celery.models.rst
+            celery.db.rst
+            celery.db.a805d4bd.rst"
 
 modules=$(find "$PACKAGE" -name "*.py")
 

+ 8 - 0
docs/internals/reference/celery.backends.database.rst

@@ -0,0 +1,8 @@
+=========================================================
+ Backend: SQLAlchemy Database - celery.backends.database
+=========================================================
+
+.. currentmodule:: celery.backends.database
+
+.. automodule:: celery.backends.database
+    :members:

+ 8 - 0
docs/internals/reference/celery.db.models.rst

@@ -0,0 +1,8 @@
+======================================
+ SQLAlchemy Models - celery.db.models
+======================================
+
+.. currentmodule:: celery.db.models
+
+.. automodule:: celery.db.models
+    :members:

+ 8 - 0
docs/internals/reference/celery.db.session.rst

@@ -0,0 +1,8 @@
+========================================
+ SQLAlchemy Session - celery.db.session
+========================================
+
+.. currentmodule:: celery.db.session
+
+.. automodule:: celery.db.session
+    :members:

+ 8 - 0
docs/internals/reference/celery.routes.rst

@@ -0,0 +1,8 @@
+=================================
+ Message Routers - celery.routes
+=================================
+
+.. currentmodule:: celery.routes
+
+.. automodule:: celery.routes
+    :members:

+ 8 - 0
docs/internals/reference/celery.utils.dispatch.rst

@@ -0,0 +1,8 @@
+=========================================
+ Signal Dispatch - celery.utils.dispatch
+=========================================
+
+.. currentmodule:: celery.utils.dispatch
+
+.. automodule:: celery.utils.dispatch
+    :members:

+ 8 - 0
docs/internals/reference/celery.utils.dispatch.saferef.rst

@@ -0,0 +1,8 @@
+==========================================================
+ Signals: Safe References - celery.utils.dispatch.saferef
+==========================================================
+
+.. currentmodule:: celery.utils.dispatch.saferef
+
+.. automodule:: celery.utils.dispatch.saferef
+    :members:

+ 8 - 0
docs/internals/reference/celery.utils.dispatch.signal.rst

@@ -0,0 +1,8 @@
+====================================================
+ Signals: Dispatcher - celery.utils.dispatch.signal
+====================================================
+
+.. currentmodule:: celery.utils.dispatch.signal
+
+.. automodule:: celery.utils.dispatch.signal
+    :members:

+ 8 - 0
docs/internals/reference/celery.utils.mail.rst

@@ -0,0 +1,8 @@
+====================================
+ Sending E-mail - celery.utils.mail
+====================================
+
+.. currentmodule:: celery.utils.mail
+
+.. automodule:: celery.utils.mail
+    :members:

+ 7 - 0
docs/internals/reference/index.rst

@@ -29,10 +29,17 @@
     celery.backends.tyrant
     celery.execute.trace
     celery.datastructures
+    celery.routes
     celery.log
+    celery.db.models
+    celery.db.session
     celery.utils
     celery.utils.timeutils
     celery.utils.info
     celery.utils.compat
+    celery.utils.mail
     celery.utils.patch
+    celery.utils.dispatch
+    celery.utils.dispatch.signal
+    celery.utils.dispatch.saferef
     celery.platform

+ 8 - 0
docs/reference/celery.bin.celeryd_multi.rst

@@ -0,0 +1,8 @@
+===============================================
+ Celeryd Multi Tool - celery.bin.celeryd_multi
+===============================================
+
+.. currentmodule:: celery.bin.celeryd_multi
+
+.. automodule:: celery.bin.celeryd_multi
+    :members:

+ 1 - 0
docs/reference/index.rst

@@ -31,3 +31,4 @@
     celery.bin.celeryd
     celery.bin.celerybeat
     celery.bin.camqadm
+    celery.bin.celeryd_multi