|
From: <mi...@us...> - 2023-06-26 11:57:18
|
Revision: 9407
http://sourceforge.net/p/docutils/code/9407
Author: milde
Date: 2023-06-26 11:57:11 +0000 (Mon, 26 Jun 2023)
Log Message:
-----------
Use "console_scripts" entry points instead of tools/rst2*.py scripts.
Update the installation of command line tools to modern standards:
Do not install scripts from the ``tools/`` directory into the binary
path. Instead, tell the installer to create and install ``rst2*``
console scripts from "entry point" definitions using functions
in `docutils.core`.
Cf. [feature-requests:88] and [patches:186].
Modified Paths:
--------------
trunk/docutils/RELEASE-NOTES.txt
trunk/docutils/setup.py
Modified: trunk/docutils/RELEASE-NOTES.txt
===================================================================
--- trunk/docutils/RELEASE-NOTES.txt 2023-06-24 20:50:32 UTC (rev 9406)
+++ trunk/docutils/RELEASE-NOTES.txt 2023-06-26 11:57:11 UTC (rev 9407)
@@ -23,34 +23,6 @@
Command line interface
----------------------
-* Docutils 0.21 will provide ``rst2*`` "console_scripts" `entry points`_
- (without the ``.py`` extension) instead of installing the
- ``rst2*.py`` `front end tools`_ in the binary PATH. [#]_
-
- You may use the ``docutils`` `generic command line front end tool`_
- as a future-proof command, for example:
-
- .. code:: diff
-
- - rst2latex.py --use-latex-abstract FAQ.txt > FAQ.tex
- + docutils --writer=latex --use-latex-abstract FAQ.txt > FAQ.tex
-
- Exceptions:
- The ``rstpep2html.py`` and ``rst2odt_prepstyles.py`` scripts
- will be retired.
-
- Use ``docutils --reader=pep --writer=pep_html`` for a PEP preview. [#]_
-
- Use ``python -m docutils.writers.odf_odt.prepstyles``
- to `strip the page size`__ from an ODT writer stylesheet.
-
- __ docs/user/odt.html#page-size
-
- .. [#] Some Linux distributions already use the short names.
- .. [#] The final rendering is done by a Sphinx-based build system
- (cf. :PEP:`676`).
-
-
* The _`command-line usage pattern` will change:
.. code:: diff
@@ -209,11 +181,27 @@
.. _csv-table: docs/ref/rst/directives.html#csv-table
-Release 0.21b (unpublished)
-===========================
+Release 0.21 (unpublished)
+==========================
* Drop support for Python 3.7 and 3.8.
+* Provide ``rst2*`` "console_scripts" `entry points`_
+ (without the ``.py`` extension) instead of installing the
+ ``rst2*.py`` `front end tools`_ in the binary PATH. [#]_
+
+ Exceptions: ``rstpep2html.py`` and ``rst2odt_prepstyles.py``:
+
+ - Use ``docutils --reader=pep --writer=pep_html`` for a PEP preview. [#]_
+ - Use ``python -m docutils.writers.odf_odt.prepstyles``
+ to `strip the page size`__ from an ODT writer stylesheet.
+
+ __ docs/user/odt.html#page-size
+
+ .. [#] Some Linux distributions already use the short names.
+ .. [#] The final rendering is done by a Sphinx-based build system
+ (cf. :PEP:`676`).
+
* Simpler and more secure `input encoding`_ default behaviour:
Do not use the locale encoding as fallback if Python is started in
@@ -1082,7 +1070,7 @@
multi-platform, multi-browser HTML slide shows.
__ docs/user/slide-shows.html
- __ docs/user/tools.html#rst2s5-py
+ __ docs/user/tools.html#rst2s5
* The newlatex2e writer is nearing completion.
Modified: trunk/docutils/setup.py
===================================================================
--- trunk/docutils/setup.py 2023-06-24 20:50:32 UTC (rev 9406)
+++ trunk/docutils/setup.py 2023-06-26 11:57:11 UTC (rev 9407)
@@ -71,22 +71,20 @@
'docutils.writers.odf_odt',
],
'entry_points': {
- 'console_scripts': ['docutils=docutils.__main__:main']
+ 'console_scripts': [
+ 'docutils = docutils.__main__:main',
+ 'rst2html = docutils.core:rst2html',
+ 'rst2html4 = docutils.core:rst2html4',
+ 'rst2html5 = docutils.core:rst2html5',
+ 'rst2latex = docutils.core:rst2latex',
+ 'rst2man = docutils.core:rst2man',
+ 'rst2odt = docutils.core:rst2odt',
+ 'rst2pseudoxml = docutils.core:rst2pseudoxml',
+ 'rst2s5 = docutils.core:rst2s5',
+ 'rst2xetex = docutils.core:rst2xetex',
+ 'rst2xml = docutils.core:rst2xml',
+ ]
},
- 'scripts': [
- 'tools/rst2html.py',
- 'tools/rst2html4.py',
- 'tools/rst2html5.py',
- 'tools/rst2s5.py',
- 'tools/rst2latex.py',
- 'tools/rst2xetex.py',
- 'tools/rst2man.py',
- 'tools/rst2xml.py',
- 'tools/rst2pseudoxml.py',
- 'tools/rstpep2html.py',
- 'tools/rst2odt.py',
- 'tools/rst2odt_prepstyles.py',
- ],
'classifiers': [
'Development Status :: 4 - Beta',
'Environment :: Console',
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|