]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commit
Tutorial draft (not finished) and documentation framework improvements
authorAlexey Shamrin <none@none>
Wed, 15 Mar 2006 13:39:11 +0000 (13:39 +0000)
committerAlexey Shamrin <none@none>
Wed, 15 Mar 2006 13:39:11 +0000 (13:39 +0000)
commit33e30aacc3b69b5d90b32d4d8e16bc9c77c43835
tree60eec14ffe8fbda757a3f6b59bb252f8fc006f74
parent7f98b58c871c690e861c16091b3c507f90b1ddda
Tutorial draft (not finished) and documentation framework improvements

* a first step to a new documentation framework, using Markdown syntax, with
  some extensions (detailed in txt2myt.py docstrings):
  * `rel:something` for internal links
  * `{@name=something}` to override default header names (used when linking)
  * `{python}` to force code block to use Python syntax highlighting (not
     needed when using examples with `>>>` prompt)
* txt2myt.py -- converter from .txt to .myt
* a draft of tutorial.txt, which uses new syntax
* testdocs.py -- check examples in documentation using doctest (currently only
  in tutorial.txt)
doc/build/content/document_base.myt
doc/build/content/trailmap.myt
doc/build/content/tutorial.txt [new file with mode: 0644]
doc/build/lib/markdown.py [new file with mode: 0644]
doc/build/testdocs.py [new file with mode: 0644]
doc/build/txt2myt.py [new file with mode: 0644]