diff options
author | Nick Fitzgerald <fitzgen@gmail.com> | 2010-07-08 09:59:49 -0700 |
---|---|---|
committer | Nick Fitzgerald <fitzgen@gmail.com> | 2010-07-08 10:56:09 -0700 |
commit | 45eb989f4283210e8abe11d8bd1ccc425284acba (patch) | |
tree | 3d7c073e1f3a1e643c999da16e9231750aa010ad | |
parent | 7571b670a09719bd32e15a33761fab27731e7f1e (diff) | |
download | pycco-45eb989f4283210e8abe11d8bd1ccc425284acba.tar.gz pycco-45eb989f4283210e8abe11d8bd1ccc425284acba.zip |
Renaming Pocco to Pycco
-rw-r--r-- | README | 19 | ||||
-rwxr-xr-x | pycco (renamed from pocco) | 34 | ||||
-rw-r--r-- | resources/pycco.css (renamed from resources/pocco.css) | 0 | ||||
-rw-r--r-- | resources/pycco.html (renamed from resources/pocco.html) | 0 | ||||
-rw-r--r-- | setup.py | 4 |
5 files changed, 30 insertions, 27 deletions
@@ -1,17 +1,20 @@ -8888888b. +888888b. 888 Y88b 888 888 -888 d88P .d88b. .d8888b .d8888b .d88b. -8888888P" d88""88b d88P" d88P" d88""88b -888 888 888 888 888 888 888 -888 Y88..88P Y88b. Y88b. Y88..88P -888 "Y88P" "Y8888P "Y8888P "Y88P" +888 d88P 888 888 .d8888b .d8888b .d88b. +8888888P" 888 888 d88P" d88P" d88""88b +888 888 888 888 888 888 888 +888 Y88b 888 Y88b. Y88b. Y88..88P +888 "Y88888 "Y8888P "Y8888P "Y88P" + 888 + Y8b d88P + "Y88P" -Pocco is a Python port of Docco: the original quick-and-dirty, +Pycco is a Python port of Docco: the original quick-and-dirty, hundred-line-long, literate-programming-style documentation generator. For more information, see: -http://fitzgen.github.com/pocco/ +http://fitzgen.github.com/pycco/ Others: @@ -1,21 +1,21 @@ #!/usr/bin/env python -# **Pocco** is a Python port of [Docco](http://jashkenas.github.com/docco/ ): +# **Pycco** is a Python port of [Docco](http://jashkenas.github.com/docco/ ): # the original quick-and-dirty, hundred-line-long, literate-programming-style # documentation generator. It produces HTML that displays your comments # alongside your code. Comments are passed through # [Markdown](http://daringfireball.net/projects/markdown/syntax), and code is # passed through [Pygments](http://pygments.org/) syntax highlighting. This -# page is the result of running Pocco against its own source file. +# page is the result of running Pycco against its own source file. # -# If you install Pocco, you can run it from the command-line: +# If you install Pycco, you can run it from the command-line: # -# pocco src/*.py +# pycco src/*.py # # ...will generate linked HTML documentation for the named source files, saving # it into a `docs` folder. # -# To install Pocco, simply +# To install Pycco, simply # # sudo setup.py install # @@ -92,18 +92,18 @@ def highlight(source, sections): # Once all of the code is finished highlighting, we can generate the HTML file # and write out the documentation. Pass the completed sections into the template -# found in `resources/pocco.html` +# found in `resources/pycco.html` def generate_html(source, sections): title = path.basename(source) dest = destination(source) - html = pocco_template({ + html = pycco_template({ "title": title, "sections": sections, "sources": sources, "path": path, "destination": destination }) - print "pocco = %s -> %s" % (source, dest) + print "pycco = %s -> %s" % (source, dest) fh = open(dest, "w") fh.write(html) fh.close() @@ -120,9 +120,9 @@ from os import path from pygments import lexers, formatters from subprocess import Popen, PIPE -# A list of the languages that Pocco supports, mapping the file extension to +# A list of the languages that Pycco supports, mapping the file extension to # the name of the Pygments lexer and the symbol that indicates a comment. To -# add another language to Pocco's repertoire, add it here. +# add another language to Pycco's repertoire, add it here. languages = { ".coffee": { "name": "coffee-script", "symbol": "#" }, ".js": { "name": "javascript", "symbol": "//" }, @@ -187,13 +187,13 @@ def ensure_directory(): def template(source): return lambda context: pystache.render(source, context) -# Create the template that we will use to generate the Pocco HTML page. -pocco_template = template(open(path.join(path.dirname(__file__), - "resources/pocco.html")).read()) +# Create the template that we will use to generate the Pycco HTML page. +pycco_template = template(open(path.join(path.dirname(__file__), + "resources/pycco.html")).read()) # The CSS styles we"d like to apply to the documentation. -pocco_styles = open(path.join(path.dirname(__file__), - "resources/pocco.css")).read() +pycco_styles = open(path.join(path.dirname(__file__), + "resources/pycco.css")).read() # The start of each Pygments highlight block. highlight_start = "<div class=\"highlight\"><pre>" @@ -208,8 +208,8 @@ if __name__ == "__main__": sources.sort() if sources: ensure_directory() - css = open("docs/pocco.css", "w") - css.write(pocco_styles) + css = open("docs/pycco.css", "w") + css.write(pycco_styles) css.close() def next_file(): diff --git a/resources/pocco.css b/resources/pycco.css index 921633b..921633b 100644 --- a/resources/pocco.css +++ b/resources/pycco.css diff --git a/resources/pocco.html b/resources/pycco.html index 9855a52..9855a52 100644 --- a/resources/pocco.html +++ b/resources/pycco.html @@ -1,10 +1,10 @@ from setuptools import setup -setup(name="Pocco", +setup(name="Pycco", version="0.1", description="""A Python port of Docco: the original quick-and-dirty, hundred-line-long, literate-programming-style documentation generator.""", author="Nick Fitzgerald", author_email="fitzgen@gmail.com", url="http://fitzgen.github.com/pocco", - scripts=["pocco"]) + scripts=["pycco"]) |