Преглед изворни кода

Even more reorganization of the documentation

Ask Solem пре 15 година
родитељ
комит
b355abbb1d

+ 2 - 0
README.rst

@@ -166,6 +166,8 @@ A look inside the components
 
 .. image:: http://cloud.github.com/downloads/ask/celery/Celery1.0-inside-worker.jpg
 
+
+
 Getting Help
 ============
 

+ 3 - 3
docs/getting-started/installation.rst → docs/getting-started/broker-installation.rst

@@ -1,6 +1,6 @@
-==============
- Installation
-==============
+=====================
+ Broker Installation
+=====================
 
 Installing RabbitMQ
 ===================

+ 2 - 1
docs/getting-started/index.rst

@@ -8,7 +8,8 @@
 .. toctree::
     :maxdepth: 2
 
-    installation
+    introduction
+    broker-installation
     first-steps-with-python
     first-steps-with-django
     periodic-tasks

+ 1 - 1
docs/introduction.rst → docs/getting-started/introduction.rst

@@ -2,4 +2,4 @@
  Introduction
 ==============
 
-.. include:: includes/introduction.txt
+.. include:: ../includes/introduction.txt

+ 0 - 43
docs/includes/introduction.txt

@@ -163,46 +163,3 @@ A look inside the components
 
 .. image:: http://cloud.github.com/downloads/ask/celery/Celery1.0-inside-worker.jpg
 
-Getting Help
-============
-
-Mailing list
-------------
-
-For discussions about the usage, development, and future of celery,
-please join the `celery-users`_ mailing list. 
-
-.. _`celery-users`: http://groups.google.com/group/celery-users/
-
-IRC
----
-
-Come chat with us on IRC. The `#celery`_ channel is located at the `Freenode`_
-network.
-
-.. _`#celery`: irc://irc.freenode.net/celery
-.. _`Freenode`: http://freenode.net
-
-
-Bug tracker
-===========
-
-If you have any suggestions, bug reports or annoyances please report them
-to our issue tracker at http://github.com/ask/celery/issues/
-
-Contributing
-============
-
-Development of ``celery`` happens at Github: http://github.com/ask/celery
-
-You are highly encouraged to participate in the development
-of ``celery``. If you don't like Github (for some reason) you're welcome
-to send regular patches.
-
-License
-=======
-
-This software is licensed under the ``New BSD License``. See the ``LICENSE``
-file in the top distribution directory for the full license text.
-
-.. # vim: syntax=rst expandtab tabstop=4 shiftwidth=4 shiftround

+ 44 - 0
docs/includes/resources.txt

@@ -0,0 +1,44 @@
+
+Getting Help
+============
+
+Mailing list
+------------
+
+For discussions about the usage, development, and future of celery,
+please join the `celery-users`_ mailing list. 
+
+.. _`celery-users`: http://groups.google.com/group/celery-users/
+
+IRC
+---
+
+Come chat with us on IRC. The `#celery`_ channel is located at the `Freenode`_
+network.
+
+.. _`#celery`: irc://irc.freenode.net/celery
+.. _`Freenode`: http://freenode.net
+
+
+Bug tracker
+===========
+
+If you have any suggestions, bug reports or annoyances please report them
+to our issue tracker at http://github.com/ask/celery/issues/
+
+Contributing
+============
+
+Development of ``celery`` happens at Github: http://github.com/ask/celery
+
+You are highly encouraged to participate in the development
+of ``celery``. If you don't like Github (for some reason) you're welcome
+to send regular patches.
+
+License
+=======
+
+This software is licensed under the ``New BSD License``. See the ``LICENSE``
+file in the top distribution directory for the full license text.
+
+.. # vim: syntax=rst expandtab tabstop=4 shiftwidth=4 shiftround

+ 1 - 2
docs/index.rst

@@ -7,10 +7,9 @@ Contents:
 .. toctree::
     :maxdepth: 2
 
-    introduction
     getting-started/index
-    configuration
     userguide/index
+    configuration
     cookbook/index
     tutorials/index
     faq

+ 5 - 0
docs/resources.rst

@@ -0,0 +1,5 @@
+===========
+ Resources
+===========
+
+.. include:: includes/resources.txt

+ 2 - 0
docs/templates/readme.txt

@@ -3,3 +3,5 @@
 =================================
 
 .. include:: ../includes/introduction.txt
+
+.. include:: ../includes/resources.txt