Changeset 121

Show
Ignore:
Timestamp:
08/02/06 08:04:02 (2 years ago)
Author:
mk
Message:

Updated docstrings and documentation for epydoc ver 3.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • branches/mk/README

    r120 r121  
    126126 
    127127in [auto-props] section. 
     128 
     129Documentation 
     130------------- 
     131 
     132Most recent code documentation should be alway available 
     133at http://agilistas.org/cheesecake/mk/docs/. You can also generate 
     134this documentation directly from the Cheesecake sources. Run this command 
     135from the main source directory:: 
     136 
     137  sh support/generate_docs.sh . 
     138 
     139:Note: Generating documentation requires `epydoc <http://epydoc.sourceforge.net/>`_ 
     140       tool installed. 
    128141 
    129142Buildbot 

  • branches/mk/cheesecake/cheesecake_index.py

    r119 r121  
    11#!/usr/bin/env python 
    2 """ 
    3 Cheesecake: How tasty is your code? 
    4  
    5 The idea of the Cheesecake project is to rank Python packages 
    6 based on various empiric "kwalitee" factors, such as: 
    7  
    8         * whether the package can be downloaded 
    9         * whether the package can be unpacked 
    10         * whether the package can be installed into an alternate directory 
    11         * existence of certain files such as README, INSTALL, LICENSE, setup.py etc. 
    12         * existence of certain directories such as doc, test, demo, examples 
    13         * percentage of modules/functions/classes/methods with docstrings 
    14         * percentage of functions/methods that are unit tested 
    15         * average pylint score for all non-test and non-demo modules 
    16         * whether the package can be unpacked 
    17         * whether the package can be installed into an alternate directory 
     2"""Cheesecake: How tasty is your code? 
     3 
     4The idea of the Cheesecake project is to rank Python packages based on various  
     5empirical "kwalitee" factors, such as: 
     6 
     7 * whether the package can be downloaded from PyPI given its name 
     8 * whether the package can be unpacked 
     9 * whether the package can be installed into an alternate directory 
     10 * existence of certain files such as README, INSTALL, LICENSE, setup.py etc. 
     11 * percentage of modules/functions/classes/methods with docstrings 
     12 * ... and many others 
    1813""" 
    1914 
    …… 
    456451        `get_attributes` function. 
    457452 
    458         :Warning: Don't use *args and **kwds arguments for this method. 
     453        :Warning: Don't use \*args and \*\*kwds arguments for this method. 
    459454        """ 
    460455        self.value = sum(self._iter_indices()) 
    …… 
    13251320        """Download package using setuptools utilities. 
    13261321 
    1327         :Ivariables: 
     1322        New attributes: 
    13281323          download_url : str 
    13291324              URL that package was downloaded from. 
    …… 
    14561451        archive types. 
    14571452 
    1458         :Ivariables: 
     1453        New attributes: 
    14591454          original_package_name : str 
     1455              Package name guessed from the package name. Will be set only 
     1456              if package name is different than unpacked directory name. 
    14601457        """ 
    14611458        self.sandbox_pkg_dir = os.path.join(self.sandbox, self.package_name) 
    …… 
    14911488        """Get package files and directories. 
    14921489 
    1493         :Ivariables: 
     1490        New attributes: 
    14941491          dirs_list : list 
    14951492              List of directories package contains. 
    …… 
    15531550        """Verify that package can be installed in alternate directory. 
    15541551 
    1555         :Ivariables: 
     1552        New attributes: 
    15561553          installed : bool 
    15571554              Describes whenever package has been succefully installed. 

  • branches/mk/support/generate_docs.sh

    r46 r121  
    11#!/bin/sh 
    22 
     3PATH=$PATH:/usr/bin:/usr/local/bin 
     4 
    35# Generate documentation for Cheesecake. 
    4 /usr/local/bin/epydoc \ 
     6epydoc \ 
     7    --html \ 
     8    --verbose \ 
    59    --docformat restructuredtext \ 
    6     -n Cheesecake \ 
    7     -u http://pycheesecake.org \ 
     10    --name Cheesecake \ 
     11    --url http://pycheesecake.org \ 
    812    -o $1/docs/ \ 
    913    cheesecake/