Changeset 4574
- Timestamp:
- 05/13/08 10:27:51 (6 months ago)
- Files:
-
- trunk/docs/index.rst (modified) (6 diffs)
- trunk/docs/README.txt (modified) (5 diffs)
- trunk/docs/_static/tg.css (added)
- trunk/docs/_static/tg.png (added)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
trunk/docs/index.rst
r4557 r4574 3 3 ========================== 4 4 5 TurboGears 2 is a reinvention of the TurboGears project to take advantage of new components, and to provide a fully cust mizable WSGI (Web Server Gateway Interface) stack. From the begining TurboGears was designed to be a Full Stack framework built from best of breed components. As time has gone on new components have been released which improved on the ones in the origornal TG stack, and the Python web world has been increasingly designed around WSGI. This has enabled a whole new world of component reuse, and TG2 is designed to take advantage of that in order to make framework which is both flexible, and productive.5 TurboGears 2 is a reinvention of the TurboGears project to take advantage of new components, and to provide a fully customizable WSGI (Web Server Gateway Interface) stack. From the begining TurboGears was designed to be a Full Stack framework built from best of breed components. As time has gone on new components have been released which improved on the ones in the original TG stack, and the Python web world has been increasingly designed around WSGI. This has enabled a whole new world of component reuse, and TG2 is designed to take advantage of this fact in order to make a framework which is both flexible, and productive. 6 6 7 TurboGears 2 is still in rapid development, and should only be used by those who are willing to put up with a little bit of API instability, but because it is well tested, and based on well tested, and known stable components it is already being used by some people in production environments. 7 TurboGears 2 is still in rapid development, and should only be used by those who are willing to put up with a little bit of API instability, but because it is well tested, and based on well tested, and known stable components it is already being used by some people in production environments. 8 8 9 9 Getting Started with TurboGears 10 10 ================================== 11 11 12 Get TurboGears 2 installed, learn how to create a new TurboGears project in a single command, and of course explore the obligatory "Hello World" example, with a few fun treats thrown in. 12 Get TurboGears 2 installed, learn how to create a new TurboGears project in a single command, and of course explore the obligatory "Hello World" example, with a few fun treats thrown in. 13 13 14 14 .. toctree:: 15 15 :maxdepth: 2 16 16 17 17 2.0/DownloadInstall 18 18 2.0/QuickStart … … 27 27 .. toctree:: 28 28 :maxdepth: 1 29 29 30 30 2.0/Wiki20/wiki20 31 31 2.0/ToscaWidgets/forms … … 36 36 .. toctree:: 37 37 :maxdepth: 2 38 39 2.0/WhatsNew 38 39 2.0/WhatsNew 40 40 41 41 General Reference for MVC Components … … 54 54 .. toctree:: 55 55 :maxdepth: 2 56 56 57 57 2.0/FormBasics 58 58 2.0/Validation … … 78 78 .. toctree:: 79 79 :maxdepth: 1 80 80 81 81 2.0/ToolBox 82 82 2.0/CommandLine 83 83 2.0/Profile 84 84 85 85 2.0/RoughDocs/CreateDatabase 86 86 2.0/RoughDocs/BootStrap … … 116 116 .. toctree:: 117 117 :maxdepth: 1 118 118 119 119 2.0/TG2Philosophy 120 120 2.0/DevStatus trunk/docs/README.txt
r4309 r4574 3 3 4 4 DOC Generation 5 -------------- -5 -------------- 6 6 7 You need to install sphinx first to generate the TurboGears 8 documentation from the docs.turbogears.org.7 Make sure that you have followed the instructions in top-level ``INSTALL.txt`` 8 file to install TurboGears 2. 9 9 10 First, run 'get_tgdoc.py' script to fetch rst docs from turbogears wiki:: 10 You also need to install Sphinx_ to generate the TurboGears documentation from 11 docs.turbogears.org:: 12 13 $ easy_install Sphinx 14 15 For the following, change to the ``docs`` directory below the top-level 16 TurboGears 2 source directory. 17 18 Then run ``get_tgdoc.py`` script to fetch rest docs from TurboGears wiki:: 11 19 12 20 $ python get_tgdoc.py 13 21 14 Then run 'make <builder>'to generate docs::22 Finally, run ``make <builder>`` to generate docs:: 15 23 16 24 $ make html 17 25 26 .. _sphinx: http://sphinx.pocoo.org/ 27 18 28 19 29 API Generation 20 -------------- -30 -------------- 21 31 22 You need to install epydoc_ 3 first to generate the TurboGears API 32 You need to install epydoc_ 3 first to generate the TurboGears API 23 33 documentation from the source code. 24 34 … … 35 45 36 46 Checking for missing doc strings 37 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~47 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 38 48 39 To check which docs need to be written, use the following command in the 49 To check which docs need to be written, use the following command in the 40 50 top directory of the TurboGears trunk source:: 41 51 42 52 $ epydoc --check tg 43 53 44 The command will check that every module, class, method, and function has a description;45 That every parameter has a description and a type; and that every variable has a type. 46 It will list those that don't meet these requirements.54 The command will check that every module, class, method, and function has a 55 description; that every parameter has a description and a type; and that every 56 variable has a type. It will list those that don't meet these requirements. 47 57 48 58 49 59 Generating HTML docs 50 ~~~~~~~~~~~~~~~~~~~~ ~~60 ~~~~~~~~~~~~~~~~~~~~ 51 61 52 62 Use this command in the top directory:: … … 56 66 to generate the TurboGears 2 API documentation in the ``apidocs`` folder. 57 67 58 You can change the settings in the file ``setup.cfg`` in the main folder 68 You can change the settings in the file ``setup.cfg`` in the main folder 59 69 to customize the output. 60 70 61 71 62 72 Writing docs 63 ~~~~~~~~~~~~ ~~73 ~~~~~~~~~~~~ 64 74 65 75 .. note:: The TurboGears project uses reStructuredText_ format for doc strings. … … 74 84 75 85 Debugging docs 76 ~~~~~~~~~~~~~~ ~86 ~~~~~~~~~~~~~~ 77 87 78 88 If you get a formatting error and want to locate the position in the source … … 85 95 .. _sourceforge: http://sourceforge.net/project/showfiles.php?group_id=32455 86 96 .. _reStructuredText: http://docutils.sourceforge.net/rst.html 97
