diff options
| author | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2021-03-05 21:14:40 +0000 |
|---|---|---|
| committer | milde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2021-03-05 21:14:40 +0000 |
| commit | 0e0d1fa82e4c03cbdbc07d7bb2071ebab67f82db (patch) | |
| tree | b156dedb2db9386d17a51c25f339af69f5e6091b /docutils/docs/dev | |
| parent | 738ea899577f07bbcc96ba58c180331975fdd115 (diff) | |
| download | docutils-0e0d1fa82e4c03cbdbc07d7bb2071ebab67f82db.tar.gz | |
Small documentation updates and fixes.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8631 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/dev')
| -rw-r--r-- | docutils/docs/dev/distributing.txt | 7 | ||||
| -rw-r--r-- | docutils/docs/dev/todo.txt | 24 |
2 files changed, 18 insertions, 13 deletions
diff --git a/docutils/docs/dev/distributing.txt b/docutils/docs/dev/distributing.txt index c60535ee7..eb0be4a11 100644 --- a/docutils/docs/dev/distributing.txt +++ b/docutils/docs/dev/distributing.txt @@ -33,17 +33,22 @@ Docutils has the following dependencies: * Docutils may optionally make use of the PIL (`Python Imaging Library`_ or Pillow_). If PIL is present, it is automatically - detected by Docutils. + detected by Docutils. * Docutils recommends the `Pygments`_ syntax hightlighter. If available, it is used for highlighting the content of `code directives`_ and roles as well as included source code files (with the "code" option to the include_ directive). +* Docutils can use the `recommonmark`_ parser to parse input in + the Markdown format (new in 0.17). + .. _Python Imaging Library: https://en.wikipedia.org/wiki/Python_Imaging_Library .. _Pillow: https://pypi.org/project/Pillow/ .. _Pygments: http://pygments.org/ +.. _recommonmark: https://pypi.org/project/recommonmark/ + .. _code directives: ../ref/rst/directives.html#code .. _include: ../ref/rst/directives.html#include diff --git a/docutils/docs/dev/todo.txt b/docutils/docs/dev/todo.txt index f34d694d8..76e8839a7 100644 --- a/docutils/docs/dev/todo.txt +++ b/docutils/docs/dev/todo.txt @@ -211,19 +211,19 @@ General * Perhaps the ``Component.supports`` method should deal with individual features ("meta" etc.) instead of formats ("html" etc.)? Currently, only the `<meta> node`_ requires the framework. - + Do we need it at all? Or rather let the writers just ignore some nodes (like we already do for "class" values)? - + The current implementation of the framework also leads to bug `bug #241`__ "doctree-based publishing != publish_string". The "components.Filter" transform is run by publish_doctree(). When filtering based on the output format, it should be run by publish_from_doctree() instead because only then the writer is known. - + So we need to either remove or fix the framework. - + __ https://sourceforge.net/p/docutils/bugs/241/ @@ -1211,16 +1211,16 @@ Handle documents only, or objects (images, etc.) also? At what point should the extensions be substituted? - Transforms_: + Transforms_: Fits well in the `Reader → Transformer → Writer`__ processing framework. - + * Filename/URL extension replacement can be done walking over the Document tree transforming the document tree from a valid state to another valid state. - + * Writer-specific configuration is still possible in the respective sections of the configuration_ file. - + __ ../peps/pep-0258.html#id24 Pre- or post-processing: @@ -2855,11 +2855,11 @@ Front-End Tools * What about if we don't know which Reader and/or Writer we are going to use? If the Reader/Writer is specified on the command-line? - + The dynamic_ front end ``tools/docutils-cli.py`` (new in 0.17) is an implementation of concept d) below. It uses 2-stage argument parsing via the `argparse` module's `partial parsing`_. It still needs some - polishing. + polishing. Perhaps have different types of front ends: @@ -2882,8 +2882,8 @@ Front-End Tools d) _`Dynamic`: Reader and/or Writer are specified by options, with defaults if unspecified (e.g. ``publish --writer manpage - [options]``). - + [options]``). + Allow common options before subcommands, as in CVS? Or group all options together? In the case of the `fully qualified`_ front ends, all the options will have to be grouped together |
