Welcome, guest | Sign In | My Account | Store | Cart

Notice! PyPM is being replaced with the ActiveState Platform, which enhances PyPM’s build and deploy capabilities. Create your free Platform account to download ActivePython or customize Python with the packages you require and get automatic updates.

Download
ActivePython
INSTALL>
pypm install document-it

How to install document_it

  1. Download and install ActivePython
  2. Open Command Prompt
  3. Type pypm install document-it
 Python 2.7Python 3.2Python 3.3
Windows (32-bit)
0.1.1 Available View build log
0.1 Available View build log
Windows (64-bit)
0.1.1 Available View build log
0.1 Available View build log
Mac OS X (10.5+)
0.1.1 Available View build log
0.1 Available View build log
Linux (32-bit)
0.1.1 Available View build log
0.1 Available View build log
Linux (64-bit)
0.1.1 Available View build log
0.1 Available View build log
 
Author
License
MPL
Dependencies
Imports
Lastest release
version 0.1.1 on Aug 6th, 2011

# DocumentIt

DocumentIt renders [markdown]() syntax to HTML and uploads it to the [Mozilla Developer Network](https://developer.mozilla.org/)

It is run by:

document-it [options] manifest [manifest] [...]

See document-it --help for options. It will render to a local temporary directory by default but you can specify its output with --dest (although you will need to pass --user and --password to POST data).

## Manifests

A manifest is in the form:

relative_file_path page_name ...

The file path is relative to the manifest.

(*TODO: more columns of options may be added in subsequent release to e.g. specify input format and expand macros)

System Message: WARNING/2 (<string>, line 25); backlink

Inline emphasis start-string without end-string.

An example manifest is at http://k0s.org/mozilla/hg/DocumentIt/file/tip/example.manifest

## TODO

Currently, to POST, DocumentIt assumes curl is available on the path. This is an obvious deficiency and it should be replaced with a request from (e.g.) urllib2.

In addition to http://developer.mozilla.org it would be nice to POST to http://wiki.mozilla.org as well. This would allow staging documents at wiki.mozilla.org and then moving to MDN.

There are other features that would be nice to have:

  • inclusion of other files
  • inclusion of --help documentation

In general the approach taken shouldn't compromise the general approach that the documentation should be the documentation, not pre-documentation. This may be achieved by the use of (e.g. regex) macros. For instance:

append(--help.*$,shell(mozmill --help))

Subscribe to package updates

Last updated Aug 6th, 2011

Download Stats

Last month:5

What does the lock icon mean?

Builds marked with a lock icon are only available via PyPM to users with a current ActivePython Business Edition subscription.

Need custom builds or support?

ActivePython Enterprise Edition guarantees priority access to technical support, indemnification, expert consulting and quality-assured language builds.

Plan on re-distributing ActivePython?

Get re-distribution rights and eliminate legal risks with ActivePython OEM Edition.