Browse Source

Made two separate module references; One public API, and one internal, making the reference more accessible.

Ask Solem 15 năm trước cách đây
mục cha
commit
a281b0e915
27 tập tin đã thay đổi với 43 bổ sung29 xóa
  1. 6 4
      contrib/doc4allmods
  2. 1 0
      docs/internals/index.rst
  3. 0 0
      docs/internals/reference/celery.backends.amqp.rst
  4. 0 0
      docs/internals/reference/celery.backends.base.rst
  5. 0 0
      docs/internals/reference/celery.backends.cache.rst
  6. 0 0
      docs/internals/reference/celery.backends.database.rst
  7. 0 0
      docs/internals/reference/celery.backends.mongodb.rst
  8. 0 0
      docs/internals/reference/celery.backends.redis.rst
  9. 0 0
      docs/internals/reference/celery.backends.rst
  10. 0 0
      docs/internals/reference/celery.backends.tyrant.rst
  11. 0 0
      docs/internals/reference/celery.beat.rst
  12. 0 0
      docs/internals/reference/celery.datastructures.rst
  13. 0 0
      docs/internals/reference/celery.discovery.rst
  14. 0 0
      docs/internals/reference/celery.log.rst
  15. 0 0
      docs/internals/reference/celery.managers.rst
  16. 0 0
      docs/internals/reference/celery.models.rst
  17. 0 0
      docs/internals/reference/celery.platform.rst
  18. 0 0
      docs/internals/reference/celery.utils.functional.rst
  19. 0 0
      docs/internals/reference/celery.utils.rst
  20. 0 0
      docs/internals/reference/celery.worker.buckets.rst
  21. 0 0
      docs/internals/reference/celery.worker.controllers.rst
  22. 0 0
      docs/internals/reference/celery.worker.job.rst
  23. 0 0
      docs/internals/reference/celery.worker.pool.rst
  24. 0 0
      docs/internals/reference/celery.worker.rst
  25. 0 0
      docs/internals/reference/celery.worker.scheduler.rst
  26. 33 0
      docs/internals/reference/index.rst
  27. 3 25
      docs/reference/index.rst

+ 6 - 4
contrib/doc4allmods

@@ -2,7 +2,7 @@
 
 PACKAGE="$1"
 SKIP_PACKAGES="$PACKAGE tests management urls"
-SKIP_FILES="celery.bin.rst celery.serialization.rst"
+SKIP_FILES="celery.bin.rst celery.contrib.rst celery.serialization.rst"
 
 modules=$(find "$PACKAGE" -name "*.py")
 
@@ -19,11 +19,13 @@ for module in $modules; do
     for skip_file in $SKIP_FILES; do
         [ "$skip_file" == "$rst" ] && skip=1
     done
-    
+
     if [ $skip -eq 0 ]; then
         if [ ! -f "docs/reference/$rst" ]; then
-            echo $rst :: FAIL
-            failed=1
+            if [ ! -f "docs/internals/reference/$rst" ]; then
+                echo $rst :: FAIL
+                failed=1
+            fi
         fi
     fi
 done

+ 1 - 0
docs/internals/index.rst

@@ -9,3 +9,4 @@
     :maxdepth: 2
 
     worker
+    reference/index

+ 0 - 0
docs/reference/celery.backends.amqp.rst → docs/internals/reference/celery.backends.amqp.rst


+ 0 - 0
docs/reference/celery.backends.base.rst → docs/internals/reference/celery.backends.base.rst


+ 0 - 0
docs/reference/celery.backends.cache.rst → docs/internals/reference/celery.backends.cache.rst


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


+ 0 - 0
docs/reference/celery.backends.mongodb.rst → docs/internals/reference/celery.backends.mongodb.rst


+ 0 - 0
docs/reference/celery.backends.redis.rst → docs/internals/reference/celery.backends.redis.rst


+ 0 - 0
docs/reference/celery.backends.rst → docs/internals/reference/celery.backends.rst


+ 0 - 0
docs/reference/celery.backends.tyrant.rst → docs/internals/reference/celery.backends.tyrant.rst


+ 0 - 0
docs/reference/celery.beat.rst → docs/internals/reference/celery.beat.rst


+ 0 - 0
docs/reference/celery.datastructures.rst → docs/internals/reference/celery.datastructures.rst


+ 0 - 0
docs/reference/celery.discovery.rst → docs/internals/reference/celery.discovery.rst


+ 0 - 0
docs/reference/celery.log.rst → docs/internals/reference/celery.log.rst


+ 0 - 0
docs/reference/celery.managers.rst → docs/internals/reference/celery.managers.rst


+ 0 - 0
docs/reference/celery.models.rst → docs/internals/reference/celery.models.rst


+ 0 - 0
docs/reference/celery.platform.rst → docs/internals/reference/celery.platform.rst


+ 0 - 0
docs/reference/celery.utils.functional.rst → docs/internals/reference/celery.utils.functional.rst


+ 0 - 0
docs/reference/celery.utils.rst → docs/internals/reference/celery.utils.rst


+ 0 - 0
docs/reference/celery.worker.buckets.rst → docs/internals/reference/celery.worker.buckets.rst


+ 0 - 0
docs/reference/celery.worker.controllers.rst → docs/internals/reference/celery.worker.controllers.rst


+ 0 - 0
docs/reference/celery.worker.job.rst → docs/internals/reference/celery.worker.job.rst


+ 0 - 0
docs/reference/celery.worker.pool.rst → docs/internals/reference/celery.worker.pool.rst


+ 0 - 0
docs/reference/celery.worker.rst → docs/internals/reference/celery.worker.rst


+ 0 - 0
docs/reference/celery.worker.scheduler.rst → docs/internals/reference/celery.worker.scheduler.rst


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

@@ -0,0 +1,33 @@
+===========================
+ Internal Module Reference
+===========================
+
+:Release: |version|
+:Date: |today|
+
+.. toctree::
+    :maxdepth: 2
+
+    celery.worker
+    celery.worker.job
+    celery.worker.controllers
+    celery.worker.buckets
+    celery.worker.scheduler
+    celery.worker.pool
+    celery.beat
+    celery.backends
+    celery.backends.base
+    celery.backends.amqp
+    celery.backends.database
+    celery.backends.cache
+    celery.backends.mongodb
+    celery.backends.redis
+    celery.backends.tyrant
+    celery.datastructures
+    celery.log
+    celery.utils
+    celery.discovery
+    celery.utils.functional
+    celery.platform
+    celery.managers
+    celery.models

+ 3 - 25
docs/reference/index.rst

@@ -1,6 +1,6 @@
-===========================
- Module API Reference
-===========================
+===============
+ API Reference
+===============
 
 :Release: |version|
 :Date: |today|
@@ -24,32 +24,10 @@
     celery.loaders.default
     celery.loaders.djangoapp
     celery.registry
-    celery.discovery
     celery.monitoring
     celery.messaging
     celery.contrib.test_runner
-    celery.worker
-    celery.worker.job
-    celery.worker.controllers
-    celery.worker.buckets
-    celery.worker.scheduler
-    celery.worker.pool
-    celery.beat
-    celery.backends
-    celery.backends.base
-    celery.backends.amqp
-    celery.backends.database
-    celery.backends.cache
-    celery.backends.mongodb
-    celery.backends.redis
-    celery.backends.tyrant
-    celery.datastructures
-    celery.log
-    celery.utils
     celery.views
-    celery.managers
-    celery.models
-    celery.platform
     celery.bin.celeryd
     celery.bin.celerybeat
     celery.bin.celeryinit