Mercurial > mozilla > hg > DocumentIt
changeset 25:0ce6b501f62d
first real version
| author | Jeff Hammel <jhammel@mozilla.com> |
|---|---|
| date | Wed, 03 Aug 2011 19:59:58 -0700 |
| parents | 045544951756 |
| children | ce7cbf3e08e1 |
| files | README.txt document_it.py example.manifest setup.py |
| diffstat | 4 files changed, 40 insertions(+), 16 deletions(-) [+] |
line wrap: on
line diff
--- a/README.txt Wed Aug 03 14:39:56 2011 -0700 +++ b/README.txt Wed Aug 03 19:59:58 2011 -0700 @@ -1,14 +1,47 @@ # DocumentIt -Mirror documentation to https://developer.mozilla.org/en/Mozmill +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) + +An example manifest is at +http://k0s.org/mozilla/hg/DocumentIt/file/tip/example.manifest ## TODO -There are several features that would be nice to have: +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 @@ -17,7 +50,3 @@ macros. For instance: append(--help.*$,shell(mozmill --help)) - - - -
--- a/document_it.py Wed Aug 03 14:39:56 2011 -0700 +++ b/document_it.py Wed Aug 03 19:59:58 2011 -0700 @@ -13,13 +13,8 @@ mozmill/README.txt https://developer.mozilla.org/en/Mozmill mozmill/docs/ https://developer.mozilla.org/en/Mozmill/ ---dest sets the destination, e.g. - ---dest http://developer.mozilla.org/ ---dest https://developer-stage9.mozilla.org/jhammel ---dest path/to directory - -By default, a new temporary directory will be created +--dest sets the destination. If a net location is specified, authentication +is required. By default, a new temporary directory will be created """ import optparse