summaryrefslogtreecommitdiff
path: root/docutils/docs/user
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2023-02-06 21:04:00 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2023-02-06 21:04:00 +0000
commitcd03b1f0575deb1fa36a9cd07e2230b156a6c053 (patch)
tree175c6fc1a165a924f6fad95fcac01ab1ccd37329 /docutils/docs/user
parent151057de56d9489200d06d939f7460c71ceab2f4 (diff)
downloaddocutils-cd03b1f0575deb1fa36a9cd07e2230b156a6c053.tar.gz
New functions for use as `rst2*` "console_scripts entry points".
The new functions allow the installation of `rst2*` command line scripts via standard `entry points`__ instead of the current "scripts" list in ``setup.py`` after a transition period (cf. [feature-requests:#88]). + Works also for Windows. + Allows shorter command names (drop the extension), already in use in Debian and Ubuntu. __ https://packaging.python.org/en/latest/specifications/entry-points/ git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9325 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/user')
-rw-r--r--docutils/docs/user/tools.txt17
1 files changed, 8 insertions, 9 deletions
diff --git a/docutils/docs/user/tools.txt b/docutils/docs/user/tools.txt
index 28456c47b..9a9078e91 100644
--- a/docutils/docs/user/tools.txt
+++ b/docutils/docs/user/tools.txt
@@ -13,11 +13,9 @@
.. contents::
.. note::
- Docutils front-end tool support is currently `under discussion`__.
- Tool names, install details and the set of auto-installed tools
- will `change in future Docutils versions`__.
+ Docutils front-end tool names, install details and the set of
+ auto-installed tools will `change in Docutils 0.21`__.
- __ https://sourceforge.net/p/docutils/feature-requests/88/
__ ../../RELEASE-NOTES.html#future-changes
--------------
@@ -73,11 +71,12 @@ list.
Generic Command Line Front End
==============================
-:Readers: Standalone (default), PEP
-:Parsers: reStructuredText (default), Markdown (requires 3rd party packages)
-:Writers: html_, html4css1_, html5_ (default), latex2e_, manpage_,
- odt_, pep_html_, pseudo-xml_, s5_html_, xelatex_, xml_,
-:Config_: `[docutils application]`_
+:CLI name: ``docutils``
+:Readers: Standalone (default), PEP
+:Parsers: reStructuredText (default), Markdown (requires 3rd party packages)
+:Writers: html_, html4css1_, html5_ (default), latex2e_, manpage_,
+ odt_, pep_html_, pseudo-xml_, s5_html_, xelatex_, xml_,
+:Config_: `[docutils application]`_
Since Docutils 0.19, you can start the generic front end like::