SF.net SVN: docutils:[9906 ] trunk/docutils
grubert--- via Docutils-checkins <[email protected]>
| Newsgroups | gmane.text.docutils.cvs |
|---|---|
| Message-ID | <[email protected]> |
Revision: 9906
http://sourceforge.net/p/docutils/code/9906
Author: grubert
Date: 2024-08-15 08:43:38 +0000 (Thu, 15 Aug 2024)
Log Message:
-----------
rename txt to rst
Modified Paths:
--------------
trunk/docutils/docs/user/Makefile.docutils-update
trunk/docutils/docutils/transforms/references.py
trunk/docutils/docutils/writers/latex2e/__init__.py
trunk/docutils/docutils/writers/odf_odt/__init__.py
trunk/docutils/docutils.conf
trunk/docutils/pyproject.toml
trunk/docutils/test/functional/expected/compact_lists.html
trunk/docutils/test/functional/expected/dangerous.html
trunk/docutils/test/functional/expected/field_name_limit.html
trunk/docutils/test/functional/expected/latex_cornercases.tex
trunk/docutils/test/functional/expected/latex_memoir.tex
trunk/docutils/test/functional/expected/math_experiments_mathml_blahtexml.html
trunk/docutils/test/functional/expected/math_experiments_mathml_pandoc.html
trunk/docutils/test/functional/expected/math_experiments_mathml_ttm.html
trunk/docutils/test/functional/expected/mathematics_mathml_blahtexml.html
trunk/docutils/test/functional/expected/mathematics_mathml_pandoc.html
trunk/docutils/test/functional/expected/mathematics_mathml_ttm.html
trunk/docutils/test/functional/expected/standalone_rst_docutils_xml.xml
trunk/docutils/test/functional/expected/standalone_rst_html4css1.html
trunk/docutils/test/functional/expected/standalone_rst_html5.html
trunk/docutils/test/functional/expected/standalone_rst_latex.tex
trunk/docutils/test/functional/expected/standalone_rst_xetex.tex
trunk/docutils/test/functional/tests/compact_lists.py
trunk/docutils/test/functional/tests/dangerous.py
trunk/docutils/test/functional/tests/field_name_limit.py
trunk/docutils/test/functional/tests/footnotes_html5.py
trunk/docutils/test/functional/tests/latex_babel.py
trunk/docutils/test/functional/tests/latex_cornercases.py
trunk/docutils/test/functional/tests/latex_cyrillic.py
trunk/docutils/test/functional/tests/latex_docinfo.py
trunk/docutils/test/functional/tests/latex_leavevmode.py
trunk/docutils/test/functional/tests/latex_literal_block.py
trunk/docutils/test/functional/tests/latex_literal_block_fancyvrb.py
trunk/docutils/test/functional/tests/latex_literal_block_listings.py
trunk/docutils/test/functional/tests/latex_literal_block_verbatim.py
trunk/docutils/test/functional/tests/latex_literal_block_verbatimtab.py
trunk/docutils/test/functional/tests/latex_memoir.py
trunk/docutils/test/functional/tests/math_output_html.py
trunk/docutils/test/functional/tests/math_output_latex.py
trunk/docutils/test/functional/tests/math_output_mathjax.py
trunk/docutils/test/functional/tests/math_output_mathml.py
trunk/docutils/test/functional/tests/misc_rst_html4css1.py
trunk/docutils/test/functional/tests/misc_rst_html5.py
trunk/docutils/test/functional/tests/pep_html.py
trunk/docutils/test/functional/tests/standalone_rst_docutils_xml.py
trunk/docutils/test/functional/tests/standalone_rst_html4css1.py
trunk/docutils/test/functional/tests/standalone_rst_html5.py
trunk/docutils/test/functional/tests/standalone_rst_html5_tuftig.py
trunk/docutils/test/functional/tests/standalone_rst_latex.py
trunk/docutils/test/functional/tests/standalone_rst_manpage.py
trunk/docutils/test/functional/tests/standalone_rst_pseudoxml.py
trunk/docutils/test/functional/tests/standalone_rst_s5_html_1.py
trunk/docutils/test/functional/tests/standalone_rst_s5_html_2.py
trunk/docutils/test/functional/tests/standalone_rst_xetex.py
trunk/docutils/test/functional/tests/xetex_cyrillic.py
trunk/docutils/test/test_CLI.py
trunk/docutils/test/test_dependencies.py
trunk/docutils/test/test_functional.py
trunk/docutils/test/test_io.py
trunk/docutils/test/test_parsers/test_rst/test_directives/test_include.py
trunk/docutils/test/test_parsers/test_rst/test_directives/test_raw.py
trunk/docutils/test/test_parsers/test_rst/test_directives/test_tables.py
trunk/docutils/test/test_parsers/test_rst/test_root_prefix.py
trunk/docutils/test/test_parsers/test_rst/test_source_line.py
trunk/docutils/test/test_parsers/test_rst/test_tables.py
trunk/docutils/test/test_publisher.py
trunk/docutils/test/test_readers/test_pep/test_inline_markup.py
trunk/docutils/test/test_settings.py
trunk/docutils/test/test_transforms/test_hyperlinks.py
trunk/docutils/test/test_utils/test__init__.py
trunk/docutils/test/test_utils/test_math/test_tex2mathml_extern.py
trunk/docutils/test/test_writers/test_html4css1_template.py
trunk/docutils/test/test_writers/test_html5_template.py
trunk/docutils/test/test_writers/test_odt.py
trunk/docutils/tools/dev/profile_docutils.py
trunk/docutils/tools/dev/unicode2rstsubs.py
trunk/docutils/tools/test/test_buildhtml.py
Added Paths:
-----------
trunk/docutils/BUGS.rst
trunk/docutils/COPYING.rst
trunk/docutils/FAQ.rst
trunk/docutils/HISTORY.rst
trunk/docutils/README.rst
trunk/docutils/RELEASE-NOTES.rst
trunk/docutils/THANKS.rst
trunk/docutils/docs/api/publisher.rst
trunk/docutils/docs/api/runtime-settings.rst
trunk/docutils/docs/api/transforms.rst
trunk/docutils/docs/dev/distributing.rst
trunk/docutils/docs/dev/enthought-plan.rst
trunk/docutils/docs/dev/enthought-rfp.rst
trunk/docutils/docs/dev/hacking.rst
trunk/docutils/docs/dev/policies.rst
trunk/docutils/docs/dev/pysource.rst
trunk/docutils/docs/dev/release.rst
trunk/docutils/docs/dev/repository.rst
trunk/docutils/docs/dev/rst/alternatives.rst
trunk/docutils/docs/dev/rst/problems.rst
trunk/docutils/docs/dev/runtime-settings-processing.rst
trunk/docutils/docs/dev/semantics.rst
trunk/docutils/docs/dev/testing.rst
trunk/docutils/docs/dev/todo.rst
trunk/docutils/docs/dev/website.rst
trunk/docutils/docs/header.rst
trunk/docutils/docs/header0.rst
trunk/docutils/docs/header2.rst
trunk/docutils/docs/howto/cmdline-tool.rst
trunk/docutils/docs/howto/html-stylesheets.rst
trunk/docutils/docs/howto/i18n.rst
trunk/docutils/docs/howto/rst-directives.rst
trunk/docutils/docs/howto/rst-roles.rst
trunk/docutils/docs/howto/security.rst
trunk/docutils/docs/index.rst
trunk/docutils/docs/peps/pep-0256.rst
trunk/docutils/docs/peps/pep-0257.rst
trunk/docutils/docs/peps/pep-0258.rst
trunk/docutils/docs/peps/pep-0287.rst
trunk/docutils/docs/ref/doctree.rst
trunk/docutils/docs/ref/rst/definitions.rst
trunk/docutils/docs/ref/rst/directives.rst
trunk/docutils/docs/ref/rst/history.rst
trunk/docutils/docs/ref/rst/introduction.rst
trunk/docutils/docs/ref/rst/mathematics.rst
trunk/docutils/docs/ref/rst/restructuredtext.rst
trunk/docutils/docs/ref/rst/roles.rst
trunk/docutils/docs/user/config.rst
trunk/docutils/docs/user/emacs.rst
trunk/docutils/docs/user/html.rst
trunk/docutils/docs/user/latex.rst
trunk/docutils/docs/user/links.rst
trunk/docutils/docs/user/mailing-lists.rst
trunk/docutils/docs/user/manpage.rst
trunk/docutils/docs/user/odt.rst
trunk/docutils/docs/user/rst/cheatsheet.rst
trunk/docutils/docs/user/rst/demo.rst
trunk/docutils/docs/user/rst/quickstart.rst
trunk/docutils/docs/user/slide-shows.rst
trunk/docutils/docs/user/smartquotes.rst
trunk/docutils/docs/user/todo-lists.rst
trunk/docutils/docs/user/tools.rst
trunk/docutils/docutils/writers/s5_html/themes/README.rst
trunk/docutils/licenses/BSD-0-Clause.rst
trunk/docutils/licenses/BSD-2-Clause.rst
trunk/docutils/licenses/ZPL-2-1.rst
trunk/docutils/licenses/gpl-3-0.rst
trunk/docutils/test/data/config_1.rst
trunk/docutils/test/data/config_2.rst
trunk/docutils/test/data/config_encoding.rst
trunk/docutils/test/data/config_encoding_2.rst
trunk/docutils/test/data/config_list.rst
trunk/docutils/test/data/config_list_2.rst
trunk/docutils/test/data/config_old.rst
trunk/docutils/test/data/config_syntax_error.rst
trunk/docutils/test/data/csv_dep.rst
trunk/docutils/test/data/dependencies.rst
trunk/docutils/test/data/full-template.rst
trunk/docutils/test/data/help/docutils.rst
trunk/docutils/test/data/help/rst2html.rst
trunk/docutils/test/data/help/rst2latex.rst
trunk/docutils/test/data/include.rst
trunk/docutils/test/data/latin1.rst
trunk/docutils/test/data/latin2.rst
trunk/docutils/test/data/raw.rst
trunk/docutils/test/data/stylesheet.rst
trunk/docutils/test/data/utf-16-le-sig.rst
trunk/docutils/test/data/utf-8-sig.rst
trunk/docutils/test/data/utf8.rst
trunk/docutils/test/functional/README.rst
trunk/docutils/test/functional/expected/standalone_rst_pseudoxml.rst
trunk/docutils/test/functional/input/compact_lists.rst
trunk/docutils/test/functional/input/cyrillic.rst
trunk/docutils/test/functional/input/dangerous.rst
trunk/docutils/test/functional/input/data/classes_latex.rst
trunk/docutils/test/functional/input/data/comprehensive-math-test.rst
trunk/docutils/test/functional/input/data/custom_roles.rst
trunk/docutils/test/functional/input/data/custom_roles_latex.rst
trunk/docutils/test/functional/input/data/embed_images.rst
trunk/docutils/test/functional/input/data/errors.rst
trunk/docutils/test/functional/input/data/header_footer.rst
trunk/docutils/test/functional/input/data/html5-features.rst
trunk/docutils/test/functional/input/data/html5-text-level-tags.rst
trunk/docutils/test/functional/input/data/hyperlinking.rst
trunk/docutils/test/functional/input/data/latex-problematic.rst
trunk/docutils/test/functional/input/data/latex_encoding.rst
trunk/docutils/test/functional/input/data/list_table.rst
trunk/docutils/test/functional/input/data/math.rst
trunk/docutils/test/functional/input/data/math_experiments.rst
trunk/docutils/test/functional/input/data/nonalphanumeric.rst
trunk/docutils/test/functional/input/data/option_lists.rst
trunk/docutils/test/functional/input/data/section_titles.rst
trunk/docutils/test/functional/input/data/standard.rst
trunk/docutils/test/functional/input/data/svg_images.rst
trunk/docutils/test/functional/input/data/swf_images.rst
trunk/docutils/test/functional/input/data/table_colspan.rst
trunk/docutils/test/functional/input/data/table_complex.rst
trunk/docutils/test/functional/input/data/table_rowspan.rst
trunk/docutils/test/functional/input/data/tables_latex.rst
trunk/docutils/test/functional/input/data/unicode.rst
trunk/docutils/test/functional/input/data/urls.rst
trunk/docutils/test/functional/input/data/video.rst
trunk/docutils/test/functional/input/field_list.rst
trunk/docutils/test/functional/input/footnotes.rst
trunk/docutils/test/functional/input/latex_babel.rst
trunk/docutils/test/functional/input/latex_cornercases.rst
trunk/docutils/test/functional/input/latex_docinfo.rst
trunk/docutils/test/functional/input/latex_leavevmode.rst
trunk/docutils/test/functional/input/latex_literal_block.rst
trunk/docutils/test/functional/input/misc_rst_html4css1.rst
trunk/docutils/test/functional/input/misc_rst_html5.rst
trunk/docutils/test/functional/input/odt_basic.rst
trunk/docutils/test/functional/input/odt_classifier.rst
trunk/docutils/test/functional/input/odt_contents.rst
trunk/docutils/test/functional/input/odt_custom_headfoot.rst
trunk/docutils/test/functional/input/odt_footnotes.rst
trunk/docutils/test/functional/input/odt_header_footer.rst
trunk/docutils/test/functional/input/odt_image.rst
trunk/docutils/test/functional/input/odt_literal_block.rst
trunk/docutils/test/functional/input/odt_nested_class.rst
trunk/docutils/test/functional/input/odt_no_class.rst
trunk/docutils/test/functional/input/odt_raw.rst
trunk/docutils/test/functional/input/odt_tables1.rst
trunk/docutils/test/functional/input/odt_unnested_class.rst
trunk/docutils/test/functional/input/pep_html.rst
trunk/docutils/test/functional/input/rst_html5_tuftig.rst
trunk/docutils/test/functional/input/simple.rst
trunk/docutils/test/functional/input/standalone_rst_docutils_xml.rst
trunk/docutils/test/functional/input/standalone_rst_html4css1.rst
trunk/docutils/test/functional/input/standalone_rst_html5.rst
trunk/docutils/test/functional/input/standalone_rst_latex.rst
trunk/docutils/test/functional/input/standalone_rst_manpage.rst
trunk/docutils/test/functional/input/standalone_rst_pseudoxml.rst
trunk/docutils/test/functional/input/standalone_rst_s5_html.rst
trunk/docutils/test/functional/input/standalone_rst_xetex.rst
trunk/docutils/test/functional/output/README.rst
trunk/docutils/test/test_parsers/test_rst/includes/include14.rst
trunk/docutils/test/test_parsers/test_rst/includes/include9.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/empty.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/include 11.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/include1.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/include10.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/include12.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/include13.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/include2.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/include3.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/include8.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/include_literal.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/include14.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/include15.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/include16.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/include4.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/include5.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/more/include6.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/sibling/include7.rst
trunk/docutils/test/test_parsers/test_rst/test_directives/raw1.rst
trunk/docutils/tools/dev/README.rst
trunk/docutils/tools/editors/README.rst
trunk/docutils/tools/editors/emacs/README.rst
trunk/docutils/tools/editors/emacs/tests/README.rst
Removed Paths:
-------------
trunk/docutils/BUGS.txt
trunk/docutils/COPYING.txt
trunk/docutils/FAQ.txt
trunk/docutils/HISTORY.txt
trunk/docutils/README.txt
trunk/docutils/RELEASE-NOTES.txt
trunk/docutils/THANKS.txt
trunk/docutils/docs/api/publisher.txt
trunk/docutils/docs/api/runtime-settings.txt
trunk/docutils/docs/api/transforms.txt
trunk/docutils/docs/dev/distributing.txt
trunk/docutils/docs/dev/enthought-plan.txt
trunk/docutils/docs/dev/enthought-rfp.txt
trunk/docutils/docs/dev/hacking.txt
trunk/docutils/docs/dev/policies.txt
trunk/docutils/docs/dev/pysource.txt
trunk/docutils/docs/dev/release.txt
trunk/docutils/docs/dev/repository.txt
trunk/docutils/docs/dev/rst/alternatives.txt
trunk/docutils/docs/dev/rst/problems.txt
trunk/docutils/docs/dev/runtime-settings-processing.txt
trunk/docutils/docs/dev/semantics.txt
trunk/docutils/docs/dev/testing.txt
trunk/docutils/docs/dev/todo.txt
trunk/docutils/docs/dev/website.txt
trunk/docutils/docs/header.txt
trunk/docutils/docs/header0.txt
trunk/docutils/docs/header2.txt
trunk/docutils/docs/howto/cmdline-tool.txt
trunk/docutils/docs/howto/html-stylesheets.txt
trunk/docutils/docs/howto/i18n.txt
trunk/docutils/docs/howto/rst-directives.txt
trunk/docutils/docs/howto/rst-roles.txt
trunk/docutils/docs/howto/security.txt
trunk/docutils/docs/index.txt
trunk/docutils/docs/peps/pep-0256.txt
trunk/docutils/docs/peps/pep-0257.txt
trunk/docutils/docs/peps/pep-0258.txt
trunk/docutils/docs/peps/pep-0287.txt
trunk/docutils/docs/ref/doctree.txt
trunk/docutils/docs/ref/rst/definitions.txt
trunk/docutils/docs/ref/rst/directives.txt
trunk/docutils/docs/ref/rst/history.txt
trunk/docutils/docs/ref/rst/introduction.txt
trunk/docutils/docs/ref/rst/mathematics.txt
trunk/docutils/docs/ref/rst/restructuredtext.txt
trunk/docutils/docs/ref/rst/roles.txt
trunk/docutils/docs/user/config.txt
trunk/docutils/docs/user/emacs.txt
trunk/docutils/docs/user/html.txt
trunk/docutils/docs/user/latex.txt
trunk/docutils/docs/user/links.txt
trunk/docutils/docs/user/mailing-lists.txt
trunk/docutils/docs/user/manpage.txt
trunk/docutils/docs/user/odt.txt
trunk/docutils/docs/user/rst/cheatsheet.txt
trunk/docutils/docs/user/rst/demo.txt
trunk/docutils/docs/user/rst/quickstart.txt
trunk/docutils/docs/user/slide-shows.txt
trunk/docutils/docs/user/smartquotes.txt
trunk/docutils/docs/user/todo-lists.txt
trunk/docutils/docs/user/tools.txt
trunk/docutils/docutils/writers/s5_html/themes/README.txt
trunk/docutils/licenses/BSD-0-Clause.txt
trunk/docutils/licenses/BSD-2-Clause.txt
trunk/docutils/licenses/ZPL-2-1.txt
trunk/docutils/licenses/gpl-3-0.txt
trunk/docutils/test/data/config_1.txt
trunk/docutils/test/data/config_2.txt
trunk/docutils/test/data/config_encoding.txt
trunk/docutils/test/data/config_encoding_2.txt
trunk/docutils/test/data/config_list.txt
trunk/docutils/test/data/config_list_2.txt
trunk/docutils/test/data/config_old.txt
trunk/docutils/test/data/config_syntax_error.txt
trunk/docutils/test/data/csv_dep.txt
trunk/docutils/test/data/dependencies.txt
trunk/docutils/test/data/full-template.txt
trunk/docutils/test/data/help/docutils.txt
trunk/docutils/test/data/help/rst2html.txt
trunk/docutils/test/data/help/rst2latex.txt
trunk/docutils/test/data/include.txt
trunk/docutils/test/data/latin1.txt
trunk/docutils/test/data/latin2.txt
trunk/docutils/test/data/raw.txt
trunk/docutils/test/data/stylesheet.txt
trunk/docutils/test/data/utf-16-le-sig.txt
trunk/docutils/test/data/utf-8-sig.txt
trunk/docutils/test/data/utf8.txt
trunk/docutils/test/functional/README.txt
trunk/docutils/test/functional/expected/standalone_rst_pseudoxml.txt
trunk/docutils/test/functional/input/compact_lists.txt
trunk/docutils/test/functional/input/cyrillic.txt
trunk/docutils/test/functional/input/dangerous.txt
trunk/docutils/test/functional/input/data/classes_latex.txt
trunk/docutils/test/functional/input/data/comprehensive-math-test.txt
trunk/docutils/test/functional/input/data/custom_roles.txt
trunk/docutils/test/functional/input/data/custom_roles_latex.txt
trunk/docutils/test/functional/input/data/embed_images.txt
trunk/docutils/test/functional/input/data/errors.txt
trunk/docutils/test/functional/input/data/header_footer.txt
trunk/docutils/test/functional/input/data/html5-features.txt
trunk/docutils/test/functional/input/data/html5-text-level-tags.txt
trunk/docutils/test/functional/input/data/hyperlinking.txt
trunk/docutils/test/functional/input/data/latex-problematic.txt
trunk/docutils/test/functional/input/data/latex_encoding.txt
trunk/docutils/test/functional/input/data/list_table.txt
trunk/docutils/test/functional/input/data/math.txt
trunk/docutils/test/functional/input/data/math_experiments.txt
trunk/docutils/test/functional/input/data/nonalphanumeric.txt
trunk/docutils/test/functional/input/data/option_lists.txt
trunk/docutils/test/functional/input/data/section_titles.txt
trunk/docutils/test/functional/input/data/standard.txt
trunk/docutils/test/functional/input/data/svg_images.txt
trunk/docutils/test/functional/input/data/swf_images.txt
trunk/docutils/test/functional/input/data/table_colspan.txt
trunk/docutils/test/functional/input/data/table_complex.txt
trunk/docutils/test/functional/input/data/table_rowspan.txt
trunk/docutils/test/functional/input/data/tables_latex.txt
trunk/docutils/test/functional/input/data/unicode.txt
trunk/docutils/test/functional/input/data/urls.txt
trunk/docutils/test/functional/input/data/video.txt
trunk/docutils/test/functional/input/field_list.txt
trunk/docutils/test/functional/input/footnotes.txt
trunk/docutils/test/functional/input/latex_babel.txt
trunk/docutils/test/functional/input/latex_cornercases.txt
trunk/docutils/test/functional/input/latex_docinfo.txt
trunk/docutils/test/functional/input/latex_leavevmode.txt
trunk/docutils/test/functional/input/latex_literal_block.txt
trunk/docutils/test/functional/input/misc_rst_html4css1.txt
trunk/docutils/test/functional/input/misc_rst_html5.txt
trunk/docutils/test/functional/input/odt_basic.txt
trunk/docutils/test/functional/input/odt_classifier.txt
trunk/docutils/test/functional/input/odt_contents.txt
trunk/docutils/test/functional/input/odt_custom_headfoot.txt
trunk/docutils/test/functional/input/odt_footnotes.txt
trunk/docutils/test/functional/input/odt_header_footer.txt
trunk/docutils/test/functional/input/odt_image.txt
trunk/docutils/test/functional/input/odt_literal_block.txt
trunk/docutils/test/functional/input/odt_nested_class.txt
trunk/docutils/test/functional/input/odt_no_class.txt
trunk/docutils/test/functional/input/odt_raw.txt
trunk/docutils/test/functional/input/odt_tables1.txt
trunk/docutils/test/functional/input/odt_unnested_class.txt
trunk/docutils/test/functional/input/pep_html.txt
trunk/docutils/test/functional/input/rst_html5_tuftig.txt
trunk/docutils/test/functional/input/simple.txt
trunk/docutils/test/functional/input/standalone_rst_docutils_xml.txt
trunk/docutils/test/functional/input/standalone_rst_html4css1.txt
trunk/docutils/test/functional/input/standalone_rst_html5.txt
trunk/docutils/test/functional/input/standalone_rst_latex.txt
trunk/docutils/test/functional/input/standalone_rst_manpage.txt
trunk/docutils/test/functional/input/standalone_rst_pseudoxml.txt
trunk/docutils/test/functional/input/standalone_rst_s5_html.txt
trunk/docutils/test/functional/input/standalone_rst_xetex.txt
trunk/docutils/test/functional/output/README.txt
trunk/docutils/test/test_parsers/test_rst/includes/include14.txt
trunk/docutils/test/test_parsers/test_rst/includes/include9.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/empty.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/include 11.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/include1.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/include10.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/include12.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/include13.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/include2.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/include3.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/include8.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/include_literal.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/include14.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/include15.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/include16.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/include4.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/include5.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/more/include6.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/includes/sibling/include7.txt
trunk/docutils/test/test_parsers/test_rst/test_directives/raw1.txt
trunk/docutils/tools/dev/README.txt
trunk/docutils/tools/editors/README.txt
trunk/docutils/tools/editors/emacs/README.txt
trunk/docutils/tools/editors/emacs/tests/README.txt
Copied: trunk/docutils/BUGS.rst (from rev 9905, trunk/docutils/BUGS.txt)
===================================================================
--- trunk/docutils/BUGS.rst (rev 0)
+++ trunk/docutils/BUGS.rst 2024-08-15 08:43:38 UTC (rev 9906)
@@ -0,0 +1,295 @@
+.. include:: docs/header0.rst
+
+================
+ Docutils_ Bugs
+================
+
+:Author: David Goodger; open to all Docutils developers
+:Contact: [email protected]
+:Date: $Date$
+:Revision: $Revision$
+:Copyright: This document has been placed in the public domain.
+
+.. _Docutils: https://docutils.sourceforge.io/
+
+
+Bugs in Docutils?!? Yes, we do have a few. Some are old-timers that
+tend to stay in the shadows and don't bother anybody. Once in a while
+new bugs are born. From time to time some bugs (new and old) crawl
+out into the light and must be dealt with. Icky.
+
+This document describes how to report a bug, and lists known bugs.
+
+.. contents::
+
+
+How To Report A Bug
+===================
+
+If you think you've discovered a bug, please read through these
+guidelines before reporting it.
+
+First, make sure it's a new bug:
+
+* Please check the list of `known bugs`_ below and the `SourceForge
+ Bug Tracker`_ to see if it has already been reported.
+
+* Are you using the very latest version of Docutils? The bug may have
+ already been fixed. Please get the latest version of Docutils from
+ the repository_ or from the current snapshot_ and check again. Even
+ if your bug has not been fixed, others probably have, and you're
+ better off with the most up-to-date code.
+
+ If you don't have time to check the latest snapshot, please report
+ the bug anyway. We'd rather tell you that it's already fixed than
+ miss reports of unfixed bugs.
+
+* If Docutils does not behave the way you expect, look in the
+ documentation_ (don't forget the FAQ_!) and `mailing list archives`_
+ for evidence that it should behave the way you expect.
+
+If you're not sure, please ask on the Docutils-users_ mailing list
+first.
+
+---------------------------------------------------------------------
+
+If it's a new bug, the most important thing you can do is to write a
+simple description and a recipe that reproduces the bug. Try to
+create a `minimal example`_ that demonstrates the bug. The easier you
+make it to understand and track down the bug, the more likely a fix
+will be.
+
+.. _minimal example:
+
+.. sidebar:: minimal example
+
+ A `minimal working example` is a complete example which is as as small and
+ simple as possible. It should be complete and working, so that
+
+ * you cannot accidentally omit information important to diagnosing
+ the problem and
+ * the person responding can just copy-and-paste the code to try it out.
+
+ To construct an example which is as small as possible, the rule
+ quite simple: *remove/leave out anything which is not necessary*.
+
+ See also: `What is a minimal working example?`__, `LaTeX FAQ`__
+
+ __ http://www.minimalbeispiel.de/mini-en.html
+ __ http://www.tex.ac.uk/cgi-bin/texfaq2html?label=minxampl
+
+Now you're ready to write the bug report. Please include:
+
+* A clear description of the bug. Describe how you expected Docutils
+ to behave, and contrast that with how it actually behaved. While
+ the bug may seem obvious to you, it may not be so obvious to someone
+ else, so it's best to avoid a guessing game.
+
+* A complete description of the environment in which you reproduced
+ the bug:
+
+ - Your operating system & version.
+ - The version of Python (``python -V``).
+ - The version of Docutils (use the "-V" option to most Docutils
+ front-end tools).
+ - Any private modifications you made to Docutils.
+ - Anything else that could possibly be relevant. Err on the side
+ of too much information, rather than too little.
+
+* A literal transcript of the *exact* command you ran, and the *exact*
+ output. Use the "--traceback" option to get a complete picture.
+
+* The exact input and output files. Create a `minimal example`_
+ of the failing behaviour — it is better to attach complete files
+ to your bug report than to include just a summary or excerpt.
+
+* If you also want to include speculation as to the cause, and even a
+ patch to fix the bug, that would be great!
+
+The best place to send your bug report is to the `SourceForge Bug
+Tracker`_. That way, it won't be misplaced or forgotten. In fact, an
+open bug report on SourceForge is a constant irritant that begs to be
+squashed.
+
+Thank you!
+
+(This section was inspired by the `Subversion project's`__ BUGS__
+file.)
+
+__ http://subversion.tigris.org/
+__ http://svn.collab.net/viewcvs/svn/trunk/BUGS?view=markup
+
+.. _repository: docs/dev/repository.html
+.. _snapshot: https://docutils.sourceforge.io/#download
+.. _documentation: docs/
+.. _FAQ: FAQ.html
+.. _mailing list archives: https://docutils.sourceforge.io/#mailing-lists
+.. _Docutils-users: docs/user/mailing-lists.html#docutils-users
+.. _SourceForge Bug Tracker:
+ https://sourceforge.net/p/docutils/bugs/
+
+
+Known Bugs
+==========
+
+Also see the `SourceForge Bug Tracker`_.
+
+* .. _error reporting:
+
+ Calling rst2s5 with a non-existent theme (``--theme
+ does_not_exist``)
+ causes exceptions. Such errors should be handled more gracefully.
+
+* The "stylesheet" setting (a URL, to be used verbatim) should be
+ allowed to be combined with "embed_stylesheet". The stylesheet data
+ should be read in using urllib. There was an assumption that a
+ stylesheet to be embedded should exist as a file on the local
+ system, and only the "stylesheet_path" setting should be used.
+
+* ``utils.relative_path()`` sometimes returns absolute _`paths on
+ Windows` (like ``C:/test/foo.css``) where it could have chosen a
+ relative path.
+
+ Furthermore, absolute pathnames are inserted verbatim, like
+ ``href="C:/test/foo.css"`` instead of
+ ``href="file:///C:/test/foo.css"``.
+
+ .. gmane web interface is down.
+ TODO: find this article in the Sourceforge mail archives
+ For details, see `this posting by Alan G. Isaac
+ <http://article.gmane.org/gmane.text.docutils.user/1569>`_.
+
+* Footnote label "5" should be "4" when processing the following
+ input::
+
+ ref [#abc]_ [#]_ [1]_ [#4]_
+
+ .. [#abc] footnote
+ .. [#] two
+ .. [1] one
+ .. [#4] four
+
+ Output::
+
+ <document source="<stdin>">
+ <paragraph>
+ ref
+ <footnote_reference auto="1" ids="id1" refid="abc">
+ 2
+
+ <footnote_reference auto="1" ids="id2" refid="id5">
+ 3
+
+ <footnote_reference ids="id3" refid="id6">
+ 1
+
+ <footnote_reference auto="1" ids="id4" refid="id7">
+ 5
+ <footnote auto="1" backrefs="id1" ids="abc" names="abc">
+ <label>
+ 2
+ <paragraph>
+ footnote
+ <footnote auto="1" backrefs="id2" ids="id5" names="3">
+ <label>
+ 3
+ <paragraph>
+ two
+ <footnote backrefs="id3" ids="id6" names="1">
+ <label>
+ 1
+ <paragraph>
+ one
+ <footnote auto="1" backrefs="id4" ids="id7" names="4">
+ <label>
+ 5
+ <paragraph>
+ four
+
+* IDs are based on names. Explicit hyperlink targets have priority
+ over implicit targets. But if an explicit target comes after an
+ implicit target with the same name, the ID of the first (implicit)
+ target remains based on the implicit name. Since HTML fragment
+ identifiers are based on the IDs, the first target keeps the name.
+ For example::
+
+ .. contents::
+
+ Section
+ =======
+
+ .. _contents:
+
+ Subsection
+ ----------
+
+ text with a reference to contents_ and section_
+
+ .. _section:
+
+ This paragraph is explicitly targeted with the name "section".
+
+ When processed to HTML, the 2 internal hyperlinks (to "contents" &
+ "section") will work fine, but hyperlinks from outside the document
+ using ``href="...#contents"`` and ``href="...#section"`` won't work.
+ Such external links will connect to the implicit targets (table of
+ contents and "Section" title) instead of the explicit targets
+ ("Subsection" title and last paragraph).
+
+ Hyperlink targets with duplicate names should be assigned new IDs
+ unrelated to the target names (i.e., "id"-prefix serial IDs).
+
+* The "contents" ID of the local table of contents in
+ ``test/functional/expected/standalone_rst_pseudoxml.rst`` is lost in
+ the HTML output at
+ ``test/functional/expected/standalone_rst_html4css1.html``.
+
+* _`Blank first columns` in simple tables with explicit row separators
+ silently swallow their input. They should at least produce system
+ error messages. But, with explicit row separators, the meaning is
+ unambiguous and ought to be supported::
+
+ ============== ==========
+ Table with row separators
+ ============== ==========
+ and blank
+ -------------- ----------
+ entries
+ -------------- ----------
+ in first
+ -------------- ----------
+ columns.
+ ============== ==========
+
+ Added a commented-out test case to
+ test/test_parsers/test_rst/test_SimpleTableParser.py.
+
+* _`Footnote references with hyperlink targets` cause a possibly
+ invalid node tree and make the HTML writer crash::
+
+ $ rst2pseudoxml
+ [1]_
+
+ .. _1: URI
+ <document source="<stdin>">
+ <paragraph>
+ <footnote_reference ids="id1" refuri="URI">
+ 1
+ <target ids="id2" names="1" refuri="URI">
+
+* Anonymous references have "name" attributes. Should they? Are they
+ used? See ``test/test_parsers/test_rst/test_inline_markup.py``.
+
+* <reference> elements have a "name" attribute, not "names". The
+ attribute should be "names"; this is an inconsistency.
+
+
+.. Emacs settings
+
+ Local Variables:
+ mode: indented-text
+ mode: rst
+ indent-tabs-mode: nil
+ sentence-end-double-space: t
+ fill-column: 70
+ End:
Deleted: trunk/docutils/BUGS.txt
===================================================================
--- trunk/docutils/BUGS.txt 2024-08-15 07:31:04 UTC (rev 9905)
+++ trunk/docutils/BUGS.txt 2024-08-15 08:43:38 UTC (rev 9906)
@@ -1,295 +0,0 @@
-.. include:: docs/header0.txt
-
-================
- Docutils_ Bugs
-================
-
-:Author: David Goodger; open to all Docutils developers
-:Contact: [email protected]
-:Date: $Date$
-:Revision: $Revision$
-:Copyright: This document has been placed in the public domain.
-
-.. _Docutils: https://docutils.sourceforge.io/
-
-
-Bugs in Docutils?!? Yes, we do have a few. Some are old-timers that
-tend to stay in the shadows and don't bother anybody. Once in a while
-new bugs are born. From time to time some bugs (new and old) crawl
-out into the light and must be dealt with. Icky.
-
-This document describes how to report a bug, and lists known bugs.
-
-.. contents::
-
-
-How To Report A Bug
-===================
-
-If you think you've discovered a bug, please read through these
-guidelines before reporting it.
-
-First, make sure it's a new bug:
-
-* Please check the list of `known bugs`_ below and the `SourceForge
- Bug Tracker`_ to see if it has already been reported.
-
-* Are you using the very latest version of Docutils? The bug may have
- already been fixed. Please get the latest version of Docutils from
- the repository_ or from the current snapshot_ and check again. Even
- if your bug has not been fixed, others probably have, and you're
- better off with the most up-to-date code.
-
- If you don't have time to check the latest snapshot, please report
- the bug anyway. We'd rather tell you that it's already fixed than
- miss reports of unfixed bugs.
-
-* If Docutils does not behave the way you expect, look in the
- documentation_ (don't forget the FAQ_!) and `mailing list archives`_
- for evidence that it should behave the way you expect.
-
-If you're not sure, please ask on the Docutils-users_ mailing list
-first.
-
----------------------------------------------------------------------
-
-If it's a new bug, the most important thing you can do is to write a
-simple description and a recipe that reproduces the bug. Try to
-create a `minimal example`_ that demonstrates the bug. The easier you
-make it to understand and track down the bug, the more likely a fix
-will be.
-
-.. _minimal example:
-
-.. sidebar:: minimal example
-
- A `minimal working example` is a complete example which is as as small and
- simple as possible. It should be complete and working, so that
-
- * you cannot accidentally omit information important to diagnosing
- the problem and
- * the person responding can just copy-and-paste the code to try it out.
-
- To construct an example which is as small as possible, the rule
- quite simple: *remove/leave out anything which is not necessary*.
-
- See also: `What is a minimal working example?`__, `LaTeX FAQ`__
-
- __ http://www.minimalbeispiel.de/mini-en.html
- __ http://www.tex.ac.uk/cgi-bin/texfaq2html?label=minxampl
-
-Now you're ready to write the bug report. Please include:
-
-* A clear description of the bug. Describe how you expected Docutils
- to behave, and contrast that with how it actually behaved. While
- the bug may seem obvious to you, it may not be so obvious to someone
- else, so it's best to avoid a guessing game.
-
-* A complete description of the environment in which you reproduced
- the bug:
-
- - Your operating system & version.
- - The version of Python (``python -V``).
- - The version of Docutils (use the "-V" option to most Docutils
- front-end tools).
- - Any private modifications you made to Docutils.
- - Anything else that could possibly be relevant. Err on the side
- of too much information, rather than too little.
-
-* A literal transcript of the *exact* command you ran, and the *exact*
- output. Use the "--traceback" option to get a complete picture.
-
-* The exact input and output files. Create a `minimal example`_
- of the failing behaviour — it is better to attach complete files
- to your bug report than to include just a summary or excerpt.
-
-* If you also want to include speculation as to the cause, and even a
- patch to fix the bug, that would be great!
-
-The best place to send your bug report is to the `SourceForge Bug
-Tracker`_. That way, it won't be misplaced or forgotten. In fact, an
-open bug report on SourceForge is a constant irritant that begs to be
-squashed.
-
-Thank you!
-
-(This section was inspired by the `Subversion project's`__ BUGS__
-file.)
-
-__ http://subversion.tigris.org/
-__ http://svn.collab.net/viewcvs/svn/trunk/BUGS?view=markup
-
-.. _repository: docs/dev/repository.html
-.. _snapshot: https://docutils.sourceforge.io/#download
-.. _documentation: docs/
-.. _FAQ: FAQ.html
-.. _mailing list archives: https://docutils.sourceforge.io/#mailing-lists
-.. _Docutils-users: docs/user/mailing-lists.html#docutils-users
-.. _SourceForge Bug Tracker:
- https://sourceforge.net/p/docutils/bugs/
-
-
-Known Bugs
-==========
-
-Also see the `SourceForge Bug Tracker`_.
-
-* .. _error reporting:
-
- Calling rst2s5 with a non-existent theme (``--theme
- does_not_exist``)
- causes exceptions. Such errors should be handled more gracefully.
-
-* The "stylesheet" setting (a URL, to be used verbatim) should be
- allowed to be combined with "embed_stylesheet". The stylesheet data
- should be read in using urllib. There was an assumption that a
- stylesheet to be embedded should exist as a file on the local
- system, and only the "stylesheet_path" setting should be used.
-
-* ``utils.relative_path()`` sometimes returns absolute _`paths on
- Windows` (like ``C:/test/foo.css``) where it could have chosen a
- relative path.
-
- Furthermore, absolute pathnames are inserted verbatim, like
- ``href="C:/test/foo.css"`` instead of
- ``href="file:///C:/test/foo.css"``.
-
- .. gmane web interface is down.
- TODO: find this article in the Sourceforge mail archives
- For details, see `this posting by Alan G. Isaac
- <http://article.gmane.org/gmane.text.docutils.user/1569>`_.
-
-* Footnote label "5" should be "4" when processing the following
- input::
-
- ref [#abc]_ [#]_ [1]_ [#4]_
-
- .. [#abc] footnote
- .. [#] two
- .. [1] one
- .. [#4] four
-
- Output::
-
- <document source="<stdin>">
- <paragraph>
- ref
- <footnote_reference auto="1" ids="id1" refid="abc">
- 2
-
- <footnote_reference auto="1" ids="id2" refid="id5">
- 3
-
- <footnote_reference ids="id3" refid="id6">
- 1
-
- <footnote_reference auto="1" ids="id4" refid="id7">
- 5
- <footnote auto="1" backrefs="id1" ids="abc" names="abc">
- <label>
- 2
- <paragraph>
- footnote
- <footnote auto="1" backrefs="id2" ids="id5" names="3">
- <label>
- 3
- <paragraph>
- two
- <footnote backrefs="id3" ids="id6" names="1">
- <label>
- 1
- <paragraph>
- one
- <footnote auto="1" backrefs="id4" ids="id7" names="4">
- <label>
- 5
- <paragraph>
- four
-
-* IDs are based on names. Explicit hyperlink targets have priority
- over implicit targets. But if an explicit target comes after an
- implicit target with the same name, the ID of the first (implicit)
- target remains based on the implicit name. Since HTML fragment
- identifiers are based on the IDs, the first target keeps the name.
- For example::
-
- .. contents::
-
- Section
- =======
-
- .. _contents:
-
- Subsection
- ----------
-
- text with a reference to contents_ and section_
-
- .. _section:
-
- This paragraph is explicitly targeted with the name "section".
-
- When processed to HTML, the 2 internal hyperlinks (to "contents" &
- "section") will work fine, but hyperlinks from outside the document
- using ``href="...#contents"`` and ``href="...#section"`` won't work.
- Such external links will connect to the implicit targets (table of
- contents and "Section" title) instead of the explicit targets
- ("Subsection" title and last paragraph).
-
- Hyperlink targets with duplicate names should be assigned new IDs
- unrelated to the target names (i.e., "id"-prefix serial IDs).
-
-* The "contents" ID of the local table of contents in
- ``test/functional/expected/standalone_rst_pseudoxml.txt`` is lost in
- the HTML output at
- ``test/functional/expected/standalone_rst_html4css1.html``.
-
-* _`Blank first columns` in simple tables with explicit row separators
- silently swallow their input. They should at least produce system
- error messages. But, with explicit row separators, the meaning is
- unambiguous and ought to be supported::
-
- ============== ==========
- Table with row separators
- ============== ==========
- and blank
- -------------- ----------
- entries
- -------------- ----------
- in first
- -------------- ----------
- columns.
- ============== ==========
-
- Added a commented-out test case to
- test/test_parsers/test_rst/test_SimpleTableParser.py.
-
-* _`Footnote references with hyperlink targets` cause a possibly
- invalid node tree and make the HTML writer crash::
-
- $ rst2pseudoxml
- [1]_
-
- .. _1: URI
- <document source="<stdin>">
- <paragraph>
- <footnote_reference ids="id1" refuri="URI">
- 1
- <target ids="id2" names="1" refuri="URI">
-
-* Anonymous references have "name" attributes. Should they? Are they
- used? See ``test/test_parsers/test_rst/test_inline_markup.py``.
-
-* <reference> elements have a "name" attribute, not "names". The
- attribute should be "names"; this is an inconsistency.
-
-
-.. Emacs settings
-
- Local Variables:
- mode: indented-text
- mode: rst
- indent-tabs-mode: nil
- sentence-end-double-space: t
- fill-column: 70
- End:
Copied: trunk/docutils/COPYING.rst (from rev 9905, trunk/docutils/COPYING.txt)
===================================================================
--- trunk/docutils/COPYING.rst (rev 0)
+++ trunk/docutils/COPYING.rst 2024-08-15 08:43:38 UTC (rev 9906)
@@ -0,0 +1,159 @@
+.. include:: docs/header0.rst
+
+==================
+ Copying Docutils
+==================
+
+:Author: David Goodger
+:Contact: [email protected]
+:Date: $Date$
+:Web site: https://docutils.sourceforge.io/
+:Copyright: This document has been placed in the public domain.
+
+Most of the files included in this project have been placed in the
+public domain, and therefore have no license requirements and no
+restrictions on copying or usage; see the `Public Domain Dedication`_
+below. There are exceptions_, listed below.
+Files in the Sandbox_ are not distributed with Docutils releases and
+may have different license terms.
+
+
+Public Domain Dedication
+========================
+
+The persons who have associated their work with this project (the
+"Dedicator": David Goodger and the many contributors to the Docutils
+project) hereby dedicate the entire copyright, less the exceptions_
+listed below, in the work of authorship known as "Docutils" identified
+below (the "Work") to the public domain.
+
+The primary repository for the Work is the Internet World Wide Web
+site <https://docutils.sourceforge.io/>. The Work consists of the
+files within the "docutils" module of the Docutils project Subversion
+repository (http://svn.code.sf.net/p/docutils/code/),
+whose Internet web interface is located at
+<https://sourceforge.net/p/docutils/code>. Files dedicated to the
+public domain may be identified by the inclusion, near the beginning
+of each file, of a declaration of the form::
+
+ Copyright: This document/module/DTD/stylesheet/file/etc. has been
+ placed in the public domain.
+
+Dedicator makes this dedication for the benefit of the public at large
+and to the detriment of Dedicator's heirs and successors. Dedicator
+intends this dedication to be an overt act of relinquishment in
+perpetuity of all present and future rights under copyright law,
+whether vested or contingent, in the Work. Dedicator understands that
+such relinquishment of all rights includes the relinquishment of all
+rights to enforce (by lawsuit or otherwise) those copyrights in the
+Work.
+
+Dedicator recognizes that, once placed in the public domain, the Work
+may be freely reproduced, distributed, transmitted, used, modified,
+built upon, or otherwise exploited by anyone for any purpose,
+commercial or non-commercial, and in any way, including by methods
+that have not yet been invented or conceived.
+
+(This dedication is derived from the text of the `Creative Commons
+Public Domain Dedication`. [#]_)
+
+.. [#] Creative Commons has `retired this legal tool`__ and does not
+ recommend that it be applied to works: This tool is based on United
+ States law and may not be applicable outside the US. For dedicating new
+ works to the public domain, Creative Commons recommend the replacement
+ Public Domain Dedication CC0_ (CC zero, "No Rights Reserved"). So does
+ the Free Software Foundation in its license-list_.
+
+ __ http://creativecommons.org/retiredlicenses
+ .. _CC0: http://creativecommons.org/about/cc0
+
+Exceptions
+==========
+
+The exceptions to the `Public Domain Dedication`_ above are:
+
+* docutils/utils/smartquotes.py
+
+ Copyright © 2011 Günter Milde,
+ based on `SmartyPants`_ © 2003 John Gruber
+ (released under a "revised" `BSD 3-Clause License`_ included in the file)
+ and smartypants.py © 2004, 2007 Chad Miller.
+ Released under the terms of the `BSD 2-Clause License`_
+ (`local copy <licenses/BSD-2-Clause.rst>`__).
+
+ .. _SmartyPants: http://daringfireball.net/projects/smartypants/
+
+* docutils/utils/math/latex2mathml.py
+
+ Copyright © Jens Jørgen Mortensen, Günter Milde.
+ Released under the terms of the `BSD 2-Clause License`_
+ (`local copy <licenses/BSD-2-Clause.rst>`__).
+
+* | docutils/utils/math/math2html.py,
+ | docutils/writers/html5_polyglot/math.css
+
+ Copyright © 2009,2010 Alex Fernández; 2021 Günter Milde
+
+ These files were part of eLyXer_, released under the `GNU
+ General Public License`_ version 3 or later. The author relicensed
+ them for Docutils under the terms of the `BSD 2-Clause License`_
+ (`local copy <licenses/BSD-2-Clause.rst>`__).
+
+ .. _eLyXer: https://github.com/alexfernandez/elyxer
+
+* | docutils/__main__.py,
+ | docutils/parsers/commonmark_wrapper.py,
+ | docutils/parsers/recommonmark_wrapper.py,
+ | docutils/utils/error_reporting.py,
+ | docutils/utils/math/__init__.py,
+ | docutils/utils/math/latex2mathml.py,
+ | docutils/utils/math/tex2mathml_extern.py,
+ | docutils/utils/punctuation_chars.py,
+ | docutils/utils/smartquotes.py,
+ | docutils/writers/html5_polyglot/__init__.py,
+ | docutils/writers/html5_polyglot/\*.css,
+ | docutils/writers/latex2e/docutils.sty,
+ | docutils/writers/xetex/__init__.py,
+ | test/test_parsers/test_recommonmark/\*.py,
+ | test/test_parsers/test_rst/test_directives/test__init__.py,
+ | test/test_parsers/test_rst/test_directives/test_code_parsing.py,
+ | test/test_parsers/test_rst/test_line_length_limit_default.py,
+ | test/test_parsers/test_rst/test_line_length_limit.py,
+ | test/test_writers/test_latex2e_misc.py,
+ | test/transforms/test_smartquotes.py,
+ | tools/docutils-cli.py,
+ | tools/rst2html5.py
+
+ Copyright © Günter Milde.
+ Released under the terms of the `BSD 2-Clause License`_
+ (`local copy <licenses/BSD-2-Clause.rst>`__).
+
+* docutils/utils/roman.py
+
+ copyright by Mark Pilgrim, released under the
+ `Zope Public License Version 2.1`_ (`local copy`__).
+
+ __ licenses/ZPL-2-1.rst
+
+* tools/editors/emacs/rst.el
+
+ copyright by Free Software Foundation, Inc.,
+ released under the `GNU General Public License`_ version 3 or later
+ (`local copy`__).
+
+ __ licenses/gpl-3-0.rst
+
+All used licenses are OSI-approved_ and GPL-compatible_.
+
+Plaintext versions of all the linked-to licenses are provided in the
+licenses_ directory.
+
+.. _sandbox: https://docutils.sourceforge.io/sandbox/README.html
+.. _licenses: licenses/
+.. _GNU General Public License: https://www.gnu.org/copyleft/gpl.html
+.. _BSD 2-Clause License: http://opensource.org/licenses/BSD-2-Clause
+.. _BSD 3-Clause License: https://opensource.org/licenses/BSD-3-Clause
+.. _Zope Public License Version 2.1: https://opensource.org/license/zpl-2-1/
+.. _OSI-approved: http://opensource.org/licenses/
+.. _license-list:
+.. _GPL-compatible: https://www.gnu.org/licenses/license-list.html
Deleted: trunk/docutils/COPYING.txt
===================================================================
--- trunk/docutils/COPYING.txt 2024-08-15 07:31:04 UTC (rev 9905)
+++ trunk/docutils/COPYING.txt 2024-08-15 08:43:38 UTC (rev 9906)
@@ -1,159 +0,0 @@
-.. include:: docs/header0.txt
-
-==================
- Copying Docutils
-==================
-
-:Author: David Goodger
-:Contact: [email protected]
-:Date: $Date$
-:Web site: https://docutils.sourceforge.io/
-:Copyright: This document has been placed in the public domain.
-
-Most of the files included in this project have been placed in the
-public domain, and therefore have no license requirements and no
-restrictions on copying or usage; see the `Public Domain Dedication`_
-below. There are exceptions_, listed below.
-Files in the Sandbox_ are not distributed with Docutils releases and
-may have different license terms.
-
-
-Public Domain Dedication
-========================
-
-The persons who have associated their work with this project (the
-"Dedicator": David Goodger and the many contributors to the Docutils
-project) hereby dedicate the entire copyright, less the exceptions_
-listed below, in the work of authorship known as "Docutils" identified
-below (the "Work") to the public domain.
-
-The primary repository for the Work is the Internet World Wide Web
-site <https://docutils.sourceforge.io/>. The Work consists of the
-files within the "docutils" module of the Docutils project Subversion
-repository (http://svn.code.sf.net/p/docutils/code/),
-whose Internet web interface is located at
-<https://sourceforge.net/p/docutils/code>. Files dedicated to the
-public domain may be identified by the inclusion, near the beginning
-of each file, of a declaration of the form::
-
- Copyright: This document/module/DTD/stylesheet/file/etc. has been
- placed in the public domain.
-
-Dedicator makes this dedication for the benefit of the public at large
-and to the detriment of Dedicator's heirs and successors. Dedicator
-intends this dedication to be an overt act of relinquishment in
-perpetuity of all present and future rights under copyright law,
-whether vested or contingent, in the Work. Dedicator understands that
-such relinquishment of all rights includes the relinquishment of all
-rights to enforce (by lawsuit or otherwise) those copyrights in the
-Work.
-
-Dedicator recognizes that, once placed in the public domain, the Work
-may be freely reproduced, distributed, transmitted, used, modified,
-built upon, or otherwise exploited by anyone for any purpose,
-commercial or non-commercial, and in any way, including by methods
-that have not yet been invented or conceived.
-
-(This dedication is derived from the text of the `Creative Commons
-Public Domain Dedication`. [#]_)
-
-.. [#] Creative Commons has `retired this legal tool`__ and does not
- recommend that it be applied to works: This tool is based on United
- States law and may not be applicable outside the US. For dedicating new
- works to the public domain, Creative Commons recommend the replacement
- Public Domain Dedication CC0_ (CC zero, "No Rights Reserved"). So does
- the Free Software Foundation in its license-list_.
-
- __ http://creativecommons.org/retiredlicenses
- .. _CC0: http://creativecommons.org/about/cc0
-
-Exceptions
-==========
-
-The exceptions to the `Public Domain Dedication`_ above are:
-
-* docutils/utils/smartquotes.py
-
- Copyright © 2011 Günter Milde,
- based on `SmartyPants`_ © 2003 John Gruber
- (released under a "revised" `BSD 3-Clause License`_ included in the file)
- and smartypants.py © 2004, 2007 Chad Miller.
- Released under the terms of the `BSD 2-Clause License`_
- (`local copy <licenses/BSD-2-Clause.txt>`__).
-
- .. _SmartyPants: http://daringfireball.net/projects/smartypants/
-
-* docutils/utils/math/latex2mathml.py
-
- Copyright © Jens Jørgen Mortensen, Günter Milde.
- Released under the terms of the `BSD 2-Clause License`_
- (`local copy <licenses/BSD-2-Clause.txt>`__).
-
-* | docutils/utils/math/math2html.py,
- | docutils/writers/html5_polyglot/math.css
-
- Copyright © 2009,2010 Alex Fernández; 2021 Günter Milde
-
- These files were part of eLyXer_, released under the `GNU
- General Public License`_ version 3 or later. The author relicensed
- them for Docutils under the terms of the `BSD 2-Clause License`_
- (`local copy <licenses/BSD-2-Clause.txt>`__).
-
- .. _eLyXer: https://github.com/alexfernandez/elyxer
-
-* | docutils/__main__.py,
- | docutils/parsers/commonmark_wrapper.py,
- | docutils/parsers/recommonmark_wrapper.py,
- | docutils/utils/error_reporting.py,
- | docutils/utils/math/__init__.py,
- | docutils/utils/math/latex2mathml.py,
- | docutils/utils/math/tex2mathml_extern.py,
- | docutils/utils/punctuation_chars.py,
- | docutils/utils/smartquotes.py,
- | docutils/writers/html5_polyglot/__init__.py,
- | docutils/writers/html5_polyglot/\*.css,
- | docutils/writers/latex2e/docutils.sty,
- | docutils/writers/xetex/__init__.py,
- | test/test_parsers/test_recommonmark/\*.py,
- | test/test_parsers/test_rst/test_directives/test__init__.py,
- | test/test_parsers/test_rst/test_directives/test_code_parsing.py,
- | test/test_parsers/test_rst/test_line_length_limit_default.py,
- | test/test_parsers/test_rst/test_line_length_limit.py,
- | test/test_writers/test_latex2e_misc.py,
- | test/transforms/test_smartquotes.py,
- | tools/docutils-cli.py,
- | tools/rst2html5.py
-
- Copyright © Günter Milde.
- Released under the terms of the `BSD 2-Clause License`_
- (`local copy <licenses/BSD-2-Clause.txt>`__).
-
-* docutils/utils/roman.py
-
- copyright by Mark Pilgrim, released under the
- `Zope Public License Version 2.1`_ (`local copy`__).
-
- __ licenses/ZPL-2-1.txt
-
-* tools/editors/emacs/rst.el
-
- copyright by Free Software Foundation, Inc.,
- released under the `GNU General Public License`_ version 3 or later
- (`local copy`__).
-
- __ licenses/gpl-3-0.txt
-
-All used licenses are OSI-approved_ and GPL-compatible_.
-
-Plaintext versions of all the linked-to licenses are provided in the
-licenses_ directory.
-
-.. _sandbox: https://docutils.sourceforge.io/sandbox/README.html
-.. _licenses: licenses/
-.. _GNU General Public License: https://www.gnu.org/copyleft/gpl.html
-.. _BSD 2-Clause License: http://opensource.org/licenses/BSD-2-Clause
-.. _BSD 3-Clause License: https://opensource.org/licenses/BSD-3-Clause
-.. _Zope Public License Version 2.1: https://opensource.org/license/zpl-2-1/
-.. _OSI-approved: http://opensource.org/licenses/
-.. _license-list:
-.. _GPL-compatible: https://www.gnu.org/licenses/license-list.html
Copied: trunk/docutils/FAQ.rst (from rev 9905, trunk/docutils/FAQ.txt)
===================================================================
--- trunk/docutils/FAQ.rst (rev 0)
+++ trunk/docutils/FAQ.rst 2024-08-15 08:43:38 UTC (rev 9906)
@@ -0,0 +1,1339 @@
+.. include:: docs/header0.rst
+
+.. NOTE TO MAINTAINERS: Please add new questions to the end of their
+ sections, so section/question numbers remain stable.
+
+===========================================
+ Docutils FAQ (Frequently Asked Questions)
+===========================================
+
+:Date: $Date$
+:Revision: $Revision$
+:Web site: https://docutils.sourceforge.io/
+:Copyright: This document has been placed in the public domain.
+
+.. contents::
+.. sectnum::
+
+
+This is a work in progress. If you are reading a local copy, the
+`master copy`_ might be newer. This document uses relative links;
+if they don't work, please use the master copy.
+
+Please feel free to ask questions and/or provide answers; send email
+to the `Docutils-users`_ mailing list. Project members should feel
+free to edit the source text file directly.
+
+.. _master copy: https://docutils.sourceforge.io/FAQ.html
+.. _let us know:
+.. _Docutils-users: docs/user/mailing-lists.html#docutils-users
+
+
+
+Docutils
+========
+
+What is Docutils?
+-----------------
+
+Docutils_ is a system for processing plaintext documentation into
+useful formats, such as HTML, XML, and LaTeX. It supports multiple
+types of input, such as standalone files, `PEPs (Python Enhancement
+Proposals)`_, and string input. Client code may add other input types,
+e.g. Sphinx_ comes with an extension to extract inline documentation
+from Python modules and packages.
+
+The Docutils distribution consists of:
+
+* a library (the "docutils" package), which `can be used by client
+ code`_;
+* several `front-end tools`_ (such as ``rst2html``, which converts
+ reStructuredText input into HTML output);
+* a `test suite`_; and
+* documentation_.
+
+For an overview of the Docutils project implementation,
+see :PEP:`258`, "Docutils Design Specification".
+
+Docutils is implemented in Python_.
+
+.. _Docutils: https://docutils.sourceforge.io/
+.. _PEPs (Python Enhancement Proposals):
+ https://peps.python.org/pep-0012
+.. _can be used by client code: docs/api/publisher.html
+.. _front-end tools: docs/user/tools.html
+.. _test suite: docs/dev/testing.html
+.. _documentation: docs/index.html
+.. _Python: https://www.python.org/
+
+
+Why is it called "Docutils"?
+----------------------------
+
+Docutils is short for "Python Documentation Utilities". The name
+"Docutils" was inspired by "Distutils", the Python Distribution
+Utilities architected by Greg Ward, a component of Python's standard
+library.
+
+The earliest known use of the term "docutils" in a Python context was
+a `fleeting reference`__ in a message by Fred Drake on 1999-12-02 in
+the Python Doc-SIG mailing list. It was suggested `as a project
+name`__ on 2000-11-27 on Doc-SIG, again by Fred Drake, in response to
+a question from Tony "Tibs" Ibbs: "What do we want to *call* this
+thing?". This was shortly after David Goodger first `announced
+reStructuredText`__ on Doc-SIG.
+
+Tibs used the name "Docutils" for `his effort`__ "to document what the
+Python docutils package should support, with a particular emphasis on
+documentation strings". Tibs joined the current project (and its
+predecessors) and graciously donated the name.
+
+For more history of reStructuredText and the Docutils project, see `An
+Introduction to reStructuredText`_.
+
+Please note that the name is "Docutils", not "DocUtils" or "Doc-Utils"
+or any other variation. It is pronounced as in "DOCumentation
+UTILitieS", with emphasis on the first syllable.
+
+.. _An Introduction to reStructuredText: docs/ref/rst/introduction.html
+__ https://mail.python.org/pipermail/doc-sig/1999-December/000878.html
+__ https://mail.python.org/pipermail/doc-sig/2000-November/001252.html
+__ https://mail.python.org/pipermail/doc-sig/2000-November/001239.html
+__ http://homepage.ntlworld.com/tibsnjoan/docutils/STpy.html
+
+
+Is there a GUI authoring environment for Docutils?
+--------------------------------------------------
+
+See the links to editors_ supporting reStructuredText.
+
+.. _editors: docs/user/links.html#editors
+
+
+What is the status of the Docutils project?
+-------------------------------------------
+
+Docutils is mainly stable, with documented APIs and architecture
+subject to change after announcement and a transition period.
+
+We fix bugs as they are reported. This means the code from the
+repository_ (or the snapshots_) is the most stable as well as the most
+featureful most of the time.
+
+
+What is the Docutils project release policy?
+--------------------------------------------
+
+Besides the regular releases_, we provide automatically-generated
+snapshots_ which always contain the latest code from the repository_.
+As the project matures, we may formalize on a
+stable/development-branch scheme, but we're not using anything like
+that yet.
+
+.. _releases: https://pypi.org/project/docutils/#history
+.. _snapshots: https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
+.. _repository: docs/dev/repository.html
+
+
+How can I get a new feature into Docutils?
+------------------------------------------
+
+* Present your idea at the docutils-develop_ mailing list or file a
+ ticket at Docutils' `feature request tracker`_.
+ Convince the Docutils developers that this is a valuable addition.
+
+* Contribute_.
+
+* Be patient, and be persistent. None of us are paid to do this,
+ it's all in our spare time, which is precious and rare.
+
+.. _docutils-develop: docs/user/mailing-lists.html#docutils-develop
+.. _extensions and related projects:
+ docs/dev/policies.html#extensions-and-related-projects
+.. _feature request tracker:
+ https://sourceforge.net/p/docutils/feature-requests/
+
+
+reStructuredText
+================
+
+What is reStructuredText?
+-------------------------
+
+reStructuredText_ is an easy-to-read, what-you-see-is-what-you-get
+plaintext markup syntax and parser system. The reStructuredText
+parser is a component of Docutils_. reStructuredText is a revision
+and reinterpretation of the StructuredText_ and Setext_ lightweight
+markup systems.
+
+If you are reading this on the web, you can see for yourself. `The
+source for this FAQ <FAQ.rst>`_ is written in reStructuredText; open
+it in another window and compare them side by side.
+
+`A ReStructuredText Primer`_ and the `Quick reStructuredText`_ user
+reference are a good place to start. The `reStructuredText Markup
+Specification`_ is a detailed technical specification.
+
+.. _A ReStructuredText Primer: docs/user/rst/quickstart.html
+.. _Quick reStructuredText: docs/user/rst/quickref.html
+.. _reStructuredText Markup Specification:
+ docs/ref/rst/restructuredtext.html
+.. _reStructuredText: https://docutils.sourceforge.io/rst.html
+.. _StructuredText:
+ http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage/
+.. _Setext: https://docutils.sourceforge.io/mirror/setext.html
+
+
+Why is it called "reStructuredText"?
+------------------------------------
+
+The name came from a combination of "StructuredText", one of
+reStructuredText's predecessors, with "re": "revised", "reworked", and
+"reinterpreted", and as in the ``re.py`` regular expression module.
+For a detailed history of reStructuredText and the Docutils project,
+see `An Introduction to reStructuredText`_.
+
+"reStructuredText" is **ONE** word, *not two!*
+
+
+What's the standard abbreviation for "reStructuredText"?
+--------------------------------------------------------
+
+"RST" and "ReST" (or "reST") are both acceptable. Care should be
+taken with capitalization, to avoid confusion with "REST__", an
+acronym for "Representational State Transfer".
+
+The abbreviations "reSTX" and "rSTX"/"rstx" should **not** be used;
+they overemphasize reStructuredText's predecessor, Zope's
+StructuredText.
+
+__ https://en.wikipedia.org/wiki/Representational_State_Transfer
+
+
+What's the standard filename extension for a reStructuredText file?
+-------------------------------------------------------------------
+
+It's ".txt". ReStructuredText source files are meant to be readable as
+plaintext, and most operating systems already associate ".txt" with text
+files.
+
+That said, we see an increasing number of projects settling on
+the extension ".rst".
+
+Also see `What's the official MIME type for reStructuredText data?`_
+
+
+Are there any reStructuredText editor extensions?
+-------------------------------------------------
+
+See the list of editors_ supporting reStructuredText.
+
+
+How can I indicate the document title? Subtitle?
+-------------------------------------------------
+
+A uniquely-adorned section title at the beginning of a document is
+treated specially, as the document title. Similarly, a
+uniquely-adorned section title immediately after the document title
+becomes the document subtitle. For example::
+
+ This is the Document Title
+ ==========================
+
+ This is the Document Subtitle
+ -----------------------------
+
+ Here's an ordinary paragraph.
+
+Counterexample::
+
+ Here's an ordinary paragraph.
+
+ This is *not* a Document Title
+ ==============================
+
+ The "ordinary paragraph" above the section title
+ prevents it from becoming the document title.
+
+Another counterexample::
+
+ This is not the Document Title, because...
+ ===========================================
+
+ Here's an ordinary paragraph.
+
+ ... the title adornment is not unique
+ =====================================
+
+ Another ordinary paragraph.
+
+
+How can I represent esoteric characters (e.g. character entities) in a document?
+--------------------------------------------------------------------------------
+
+For example, say you want an em-dash (XML character entity —,
+Unicode character U+2014) in your document: use a real em-dash.
+Insert literal characters (e.g. type a *real* em-dash) into your
+input file, using whatever encoding suits your application, and tell
+Docutils the input encoding. Docutils uses Unicode internally, so the
+em-dash character is U+2014 internally.
+
+Emacs users should refer to the `Emacs Support for reStructuredText`__
+document. Tips for other editors are welcome.
+
+__ tools/editors/emacs/README.html
+
+ReStructuredText has no character entity subsystem; it doesn't know
+anything about XML character entities.
+To Docutils, "—" in input text is
+7 discrete characters; no interpretation happens. When writing HTML,
+the "&" is converted to "&", so in the raw output you'd see
+"&mdash;". There's no difference in interpretation for text
+inside or outside inline literals or literal blocks -- there's no
+character entity interpretation in either case.
+
+If you can't use a Unicode-compatible encoding and must rely on 7-bit
+ASCII, there is a workaround:
+`Standard Substitution Definition Sets`_ provide equivalents of
+XML & HTML character entity sets as substitution definitions. [#]_
+For example, the Japanese yen currency symbol can be used as follows::
+
+ .. include:: <xhtml1-lat1.txt>
+
+ |yen| 600 for a complete meal? That's cheap!
+
+.. [#] Thanks to David Priest for the original idea.
+
+You can create custom `substitution definitions`_ in your document
+using the "unicode_" directive, e.g.::
+
+ .. |--| unicode:: U+2013 .. en dash
+ .. |---| unicode:: U+2014 .. em dash, trimming surrounding whitespace
+ :trim:
+
+.. |--| unicode:: U+2013 .. en dash
+.. |---| unicode:: U+2014 .. em dash, trimming surrounding whitespace
+ :trim:
+
+Now you can write dashes using pure ASCII: "``foo |--| bar; foo |---|
+bar``", rendered as "foo |--| bar; foo |---| bar".
+The ``:trim:`` option for
+the em dash is necessary because you cannot write "``foo|---|bar``";
+thus you need to add spaces ("``foo |---| bar``") and advise the
+reStructuredText parser to trim the spaces.
+
+.. _Standard Substitution Definition Sets: docs/ref/rst/definitions.html
+.. _substitution definitions: docs/ref/rst/restructuredtext.html
+ #substitution-definitions
+.. _unicode: docs/ref/rst/directives.html#unicode-character-codes
+
+
+How can I generate backticks using a Scandinavian keyboard?
+-----------------------------------------------------------
+
+The use of backticks in reStructuredText is a bit awkward with
+Scandinavian keyboards, where the backtick is a "dead" key. To get
+one ` character one must press SHIFT-` + SPACE.
+
+Unfortunately, with all the variations out there, there's no way to
+please everyone. For Scandinavian programmers and technical writers,
+this is not limited to reStructuredText but affects many languages and
+environments.
+
+Possible solutions include
+
+* If you have to input a lot of backticks, simply type one in the
+ normal/awkward way, select it, copy and then paste the rest (CTRL-V
+ is a lot faster than SHIFT-` + SPACE).
+
+* Use keyboard macros.
+
+* Remap the keyboard. The Scandinavian keyboard layout is awkward for
+ other programming/technical characters too; for example, []{}
+ etc. are a bit awkward compared to US keyboards.
+
+ According to Axel Kollmorgen,
+
+ Under Windows, you can use the `Microsoft Keyboard Layout Creator
+ <http://www.microsoft.com/globaldev/tools/msklc.mspx>`__ to easily
+ map the backtick key to a real backtick (no dead key). took me
+ five minutes to load my default (german) keyboard layout, untick
+ "Dead Key?" from the backtick key properties ("in all shift
+ states"), "build dll and setup package", install the generated
+ .msi, and add my custom keyboard layout via Control Panel >
+ Regional and Language Options > Languages > Details > Add
+ Keyboard layout (and setting it as default "when you start your
+ computer").
+
+* Use a virtual/screen keyboard or character palette, such as:
+
+ - `Web-based keyboards <http://keyboard.lab.co.il/>`__ (IE only
+ unfortunately).
+ - Windows: `Click-N-Type <http://www.lakefolks.org/cnt/>`__.
+ - Mac OS X: the Character Palette can store a set of favorite
+ characters for easy input. Open System Preferences,
+ International, Input Menu tab, enable "Show input menu in menu
+ bar", and be sure that Character Palette is enabled in the list.
+
+If anyone knows of other/better solutions, please `let us know`_.
+
+
+Are there any tools for HTML/XML-to-reStructuredText? (Round-tripping)
+-----------------------------------------------------------------------
+
+People have tossed the idea around, and some implementations of
+reStructuredText-generating tools can be found in the `Docutils Link
+List`_.
+
+There's no reason why reStructuredText should not be round-trippable
+to/from XML; any technicalities which prevent round-tripping would be
+considered bugs. Whitespace would not be identical, but paragraphs
+shouldn't suffer. The tricky parts would be the smaller details, like
+links and IDs and other bookkeeping.
+
+For HTML, true round-tripping may not be possible. Even adding lots
+of extra "class" attributes may not be enough. A "simple HTML" to RST
+filter is possible -- for some definition of "simple HTML" -- but HTML
+is used as dumb formatting so much that such a filter may not be
+particularly useful. An 80/20 approach should work though: build a
+tool that does 80% of the work automatically, leaving the other 20%
+for manual tweaks.
+
+.. _Docutils Link List: docs/user/links.html
+
+
+Are there any Wikis that use reStructuredText syntax?
+-----------------------------------------------------
+
+There are several, with various degrees of completeness. With no
+implied endorsement or recommendation, and in no particular order:
+
+* `Ian Bicking's experimental code
+ <https://docutils.sourceforge.io/sandbox/ianb/wiki/Wiki.py>`__
+
+* `MoinMoin <http://moinmoin.wikiwikiweb.de/>`__ has some support;
+ `here's a sample <http://moinmoin.wikiwikiweb.de/RestSample>`__
+
+* Zope-based `Zwiki <http://zwiki.org/>`__
+
+* Zope3-based Zwiki (in the Zope 3 source tree as
+ ``zope.products.zwiki``)
+
+* `StikiWiki <http://mithrandr.moria.org/code/stikiwiki/>`__
+
+* `Trac <http://trac.edgewall.com//>`__ `supports using
+ reStructuredText
+ <http://trac.edgewall.com//wiki/WikiRestructuredText>`__ as
+ an alternative to wiki markup. This includes support for `TracLinks
+ <http://trac.edgewall.com//wiki/TracLinks>`__ from within
+ RST text via a custom RST reference-directive or, even easier, an
+ interpreted text role 'trac'
+
+Please `let us know`_ of any other reStructuredText Wikis.
+
+.. dead link
+.. The example application for the `Web Framework Shootout
+.. <http://colorstudy.com/docs/shootout.html>`__ article is a Wiki using
+.. reStructuredText.
+
+
+Are there any Weblog (Blog) projects that use reStructuredText syntax?
+----------------------------------------------------------------------
+
+With no implied endorsement or recommendation, and in no particular
+order:
+
+* `Firedrop <http://www.voidspace.org.uk/python/firedrop2/>`__
+* `PyBloxsom <http://pyblosxom.github.io/>`__
+* `Lino WebMan <http://lino.sourceforge.net/webman.html>`__
+* `Pelican <http://blog.getpelican.com/>`__
+ (also listed `on PyPi <http://pypi.python.org/pypi/pelican>`__)
+
+Please `let us know`_ of any other reStructuredText Blogs.
+
+
+.. _Can lists be indented without generating block quotes?:
+
+How should I mark up lists?
+---------------------------
+
+Bullet_ & enumerated_ list markup is very intuitive but there are 2
+points that must be noted:
+
+.. _bullet: docs/ref/rst/restructuredtext.html#bullet-lists
+.. _enumerated: docs/ref/rst/restructuredtext.html#enumerated-lists
+
+1. Lists should **not** be indented. This is correct::
+
+ paragraph
+
+ * list item 1
+
+ * nested item 1.1
+ * nested item 1.2
+
+ * list item 2
+
+ while this is probably incorrect::
+
+ paragraph
+
+ * list item 1
+
+ * nested item 1.1
+ * nested item 1.2
+
+ * list item 2
+
+ The extra indentation (of the list containing items 1.1 and 1.2) is
+ recognized as a block quote. This is usually not what you mean and
+ it causes the list in the output to be indented too much.
+
+2. There **must** be blank lines around list items, except between
+ items of the same level, where blank lines are optional. The
+ example above shows this.
+
+Note that formatting of the *output* is independent of the input, and
+is decided by the writer and the stylesheet. For instance, lists
+*are* indented in HTML output by default. See `How are lists
+formatted in HTML?`_ for details.
+
+
+Could lists be indented without generating block quotes?
+--------------------------------------------------------
+
+Some people like to write lists with indentation but don't intend a
+blockquote context. There has been a lot of discussion about allowing
+this in reStructuredText, but there are some issues that would need to
+be resolved before it could be implemented. There is a summary of the
+issues and pointers to the discussions in `the to-do list`__.
+
+__ docs/dev/todo.html#indented-lists
+
+
+Could the requirement for blank lines around lists be relaxed?
+--------------------------------------------------------------
+
+Short answer: no.
+
+In reStructuredText, it would be impossible to unambiguously mark up
+and parse lists without blank lines before and after. Deeply nested
+lists may look ugly with so many blank lines, but it's a price we pay
+for unambiguous markup. Some other plaintext markup systems do not
+require blank lines in nested lists, but they have to compromise
+somehow, either accepting ambiguity or requiring extra complexity.
+For example, `Epytext <http://epydoc.sourceforge.net/epytext.html#list>`__ does
+not require blank lines around lists, but it does require that lists
+be indented and that ambiguous cases be escaped.
+
+
+How can I include mathematical equations in documents?
+------------------------------------------------------
+
+Use `LaTeX math syntax`_ in a `math directive`_ or `math role`_.
+
+.. _LaTeX math syntax: docs/ref/rst/mathematics.html
+.. _math directive: docs/ref/rst/directives.html#math
+.. _math role: docs/ref/rst/roles.html#math
+
+
+Is nested inline markup possible?
+---------------------------------
+
+Not currently, no. It's on the `to-do list`__ (`details here`__), and
+hopefully will be part of the reStructuredText parser soon. At that
+time, markup like this will become possible::
+
+ Here is some *emphasized text containing a `hyperlink`_ and
+ ``inline literals``*.
+
+__ docs/dev/todo.html#nested-inline-markup
+__ docs/dev/rst/alternatives.html#nested-inline-markup
+
+There are workarounds, but they are either convoluted or ugly or both.
+They are not recommended.
+
+* Inline markup can be combined with hyperlinks using `substitution
+ definitions`__ and references__ with the `"replace" directive`__.
+ For example::
+
+ Here is an |emphasized hyperlink|_.
+
+ .. |emphasized hyperlink| replace:: *emphasized hyperlink*
+ .. _emphasized hyperlink: https://example.org
+
+ It is not possible for just a portion of the replacement text to be
+ a hyperlink; it's the entire replacement text or nothing.
+
+ __ docs/ref/rst/restructuredtext.html#substitution-definitions
+ __ docs/ref/rst/restructuredtext.html#substitution-references
+ __ docs/ref/rst/directives.html#replace
+
+* The `"raw" directive`__ can be used to insert raw HTML into HTML
+ output::
+
+ Here is some |stuff|.
+
+ .. |stuff| raw:: html
+
+ <em>emphasized text containing a
+ <a href="https://example.org">hyperlink</a> and
+ <tt>inline literals</tt></em>
+
+ Raw LaTeX is supported for LaTeX output, etc.
+
+ __ docs/ref/rst/directives.html#raw
+
+
+How to indicate a line break or a significant newline?
+------------------------------------------------------
+
+`Line blocks`__ are designed for address blocks, verse, and other
+cases where line breaks are significant and must be preserved. Unlike
+literal blocks, the typeface is not changed, and inline markup is
+recognized. For example::
+
+ | A one, two, a one two three four
+ |
+ | Half a bee, philosophically,
+ | must, *ipso facto*, half not be.
+ | But half the bee has got to be,
+ | *vis a vis* its entity. D'you see?
+ |
+ | But can a bee be said to be
+ | or not to be an entire bee,
+ | when half the bee is not a bee,
+ | due to some ancient injury?
+ |
+ | Singing...
+
+__ docs/ref/rst/restructuredtext.html#line-blocks
+
+Here's a workaround for manually inserting explicit line breaks in
+HTML output::
+
+ .. |br| raw:: html
+
+ <br />
+
+ I want to break this line here: |br| this is after the break.
+
+ If the extra whitespace bothers you, |br|\ backslash-escape it.
+
+
+A URL containing asterisks doesn't work. What to do?
+-----------------------------------------------------
+
+Asterisks are valid URL characters (see :RFC:`2396`), sometimes used
+in URLs. For example::
+
+ http://cvs.example.org/viewcvs.py/*checkout*/module/file
+
+Unfortunately, the parser thinks the asterisks are indicating
+emphasis. The slashes serve as delineating punctuation, allowing the
+asterisks to be recognized as markup. The example above is separated
+by the parser into a truncated URL, an emphasized word, and some
+regular text::
+
+ http://cvs.example.org/viewcvs.py/
+ *checkout*
+ /module/file
+
+To turn off markup recognition, use a backslash to escape at least the
+first asterisk, like this::
+
+ http://cvs.example.org/viewcvs.py/\*checkout*/module/file
+
+Escaping the second asterisk doesn't hurt, but it isn't necessary.
+
+
+How can I make a literal block with *some* formatting?
+------------------------------------------------------
+
+Use the `parsed-literal`_ directive.
+
+.. _parsed-literal: docs/ref/rst/directives.html#parsed-literal
+
+Scenario: a document contains some source code, which calls for a
+literal block to preserve linebreaks and whitespace. But part of the
+source code should be formatted, for example as emphasis or as a
+hyperlink. This calls for a *parsed* literal block::
+
+ .. parsed-literal::
+
+ print "Hello world!" # *tricky* code [1]_
+
+The emphasis (``*tricky*``) and footnote reference (``[1]_``) will be
+parsed.
+
+
+Can reStructuredText be used for web or generic templating?
+-----------------------------------------------------------
+
+Docutils and reStructuredText can be used with or as a component of a
+templating system, but they do not themselves include templating
+functionality. Templating should simply be left to dedicated
+templating systems. Users can choose a templating system to apply to
+their reStructuredText documents as best serves their interests.
+
+There are many good templating systems for Python (ht2html_, YAPTU_,
+Quixote_'s PTL, Cheetah_, etc.; see this non-exhaustive list of `some
+other templating systems`_), and many more for other languages, each
+with different approaches. We invite you to try several and find one
+you like. If you adapt it to use Docutils/reStructuredText, please
+consider contributing the code to Docutils or `let us know`_ and we'll
+keep a list here.
+
+One reST-specific web templating system is `rest2web
+<http://www.voidspace.org.uk/python/rest2web>`_, a tool for
+automatically building websites, or parts of websites.
+
+.. _ht2html: http://ht2html.sourceforge.net/
+.. _YAPTU:
+ http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52305
+.. _Quixote: http://www.mems-exchange.org/software/quixote/
+.. _Cheetah: http://www.cheetahtemplate.org/
+.. _some other templating systems:
+ http://webware.sourceforge.net/Papers/Templates/
+
+
+How can I mark up a FAQ or other list of questions & answers?
+-------------------------------------------------------------
+
+There is no specific syntax for FAQs and Q&A lists. Here are two
+options:
+
+1. For a FAQ (Frequently Asked Questions, usually with answers), a
+ convenient way to mark up the questions is as section titles, with
+ the answer(s) as section content. This document is marked up in
+ this way.
+
+ The advantages of using section titles for questions are: sections
+ can be numbered automatically, and a table of contents can be
+ generated automatically. One limitation of this format is that
+ questions must fit on one line (section titles may not wrap, in the
+ source text). For very long questions, the title may be a summary
+ of the question, with the full question in the section body.
+
+2. Field lists work well as Q&A lists::
+
+ :Q: What kind of questions can we
+ put here?
+
+ :A: Any kind we like!
+
+ In order to separate questions, lists can be used:
+
+ 1. :Q: What kind of question can we
+ put here?
+ :A: Any kind we like!
+
+ 2. :Q: How many answers can a question have?
+ :A: It can have one,
+ :A: or more.
+ :A3: Answers can be numbered like this.
+ :A: 1. Or like this.
+ 2. We're flexible!
+
+ If you don't want to number or otherwise mark questions, you can
+ use an empty comment between individual field lists to separate
+ them::
+
+ :Q: First question?
+ :A: Answer.
+
+ ..
+
+ :Q: Second question?
+ :A: Answer.
+
+
+.. _bidi:
+
+Can I produce documents in right-to-left languages?
+---------------------------------------------------
+
+Languages written from right to left, such as Arabic and Hebrew, must
+be reordered according to the `Unicode Bidi Algorithm`_. This
+requires support from the editor and special markup in the output
+format.
+
+The source format of reStructuredText is relatively bidi-friendly:
+most constructs are denoted by punctuation without intrusion of
+English and when you must write in English, it's usually on a separate
+line. So any editor that auto-detects direction per-line (like gedit
+or geresh_) will suffice.
+
+Moreover, it's possible to translate_ all reStructuredText keywords.
+Docutils 0.17 includes translations for Arab, Hebrew, and
+Persian/Farsi. This should allow reasonable use of editors limited to
+a single base direction for the whole document (like Notepad, Vim and
+text boxes in Firefox).
+
+.. _Unicode Bidi Algorithm: https://www.unicode.org/reports/tr9/
+.. _geresh: http://www.typo.co.il/~mooffie/geresh/
+.. _translate: docs/howto/i18n.html
+
+The second problem is bidi markup of the output. There is an almost
+transparent implicit solution for HTML:
+
+* Grab http://cben-hacks.sourceforge.net/bidi/hibidi.py and
+ http://cben-hacks.sourceforge.net/bidi/rst2html_hibidi.py.
+ Put them both in the same directory and make them executable.
+
+* Use ``rst2html_hibidi.py`` instead of ``rst2html``.
+
+* It infers dir attributes in the HTML from the text. It does it
+ hierachically, giving much better results than usual. You can still
+ use LRM/RLM and LRE/RLE/PDF control codes to help it.
+
+ * If you want the gory details: See the full theory_, and note the
+ incomplete practice_ (this is still a partial implementation - but
+ sufficient for most needs).
+
+ .. _theory: http://cben-hacks.sourceforge.net/bidi/hibidi.html
+ .. _practice: http://cben-hacks.sourceforge.net/bidi/hibidi.html#practice
+
+There is also an explicit way to set directions through CSS and
+classes in the HTML:
+
+* Copy ``default.css`` to a new file and add relevant parts of the
+ following::
+
+ /* Use these two if the main document direction is RTL */
+ body { direction: rtl; }
+ div.sidebar { float: left !important; }
+
+ /* The next 3 rules are very useful in documents containing pieces
+ of code in english */
+ /* Use this if you all your literal blocks (::) are LTR */
+ pre {direction: ltr; unicode-bidi: embed; }
+ /* Use this if you all your inline literals (``) are LTR */
+ tt {direction: ltr; unicode-bidi: embed; }
+ /* Use this if you all your interpreted text (`) is LTR */
+ cite {direction: ltr; unicode-bidi: embed; }
+
+ /* Allow manual direction override by class directive and roles */
+ .rtl { direction: rtl; }
+ .ltr { direction: ltr; }
+
+* Select this new stylesheet with ``--stylesheet=<file>`` or the
+ stylesheet_ setting.
+
+* Now if you need to override the direction of some element (from a
+ paragraph to a whole section), write::
+
+ .. class:: rtl
+
+ or::
+
+ .. class:: ltr
+
+ before it (see the class_ directive for details).
+
+* To change the direction of some inline text fragment, you can use
+ RLE/LRE/PDF control characters, or write ``:rtl:`RTL text``` /
+ ``:ltr:`RTL text```. To use the latter syntax, you must write this
+ once at the beginning of your document::
+
+ .. role:: ltr
+ .. role:: rtl
+
+.. _stylesheet: docs/user/config.html#stylesheet
+.. _class: docs/ref/rst/directives.rst#class
+
+LaTeX is quite hard to implement (it doesn't support the bidi
+algorithm, so all direction changes - even numbers in RTL text - must
+be explicitly marked). Other formats are more-or-less easy.
+
+If you have any questions/problems/bugs related to bidi with docutils,
+ask `Beni Cherniavsky`__ directly or the `Docutils-users`_ mailing
+list.
+
+__ mailto:[email protected]
+
+
+What's the official MIME type for reStructuredText data?
+--------------------------------------------------------
+
+While there is no registered MIME type for reStructuredText, the
+"official unofficial" standard MIME type is "text/x-rst". [#]_ This was
+invented for the build system for PEPs (Python Enhancement Proposals),
+and it's used by the python.org web site build system.
+
+Also see `What's the standard filename extension for a
+reStructuredText file?`_
+
+.. [#] The "x-" prefix means it's an unregistered MIME type.
+
+
+How can I mark up a TODO list?
+------------------------------
+
+You may use a field list with class argument and some CSS styling.
+For an example see `Docutils TODO lists`_ and its source todo-lists.rst_.
+
+.. _Docutils TODO lists: docs/user/todo-lists.html
+.. _todo-lists.rst: docs/user/todo-lists.rst
+
+
+How can I specify an image grid?
+--------------------------------
+
+In order to arrange images (or other content) in a grid,
+a borderless `list table`_ can be used. For example::
+
+ .. list-table::
+ :class: borderless
+
+ * - .. image:: rst/images/title-scaling.svg
+ - .. image:: rst/images/biohazard.svg
+ * - .. image:: rst/images/biohazard.svg
+ - .. image:: rst/images/biohazard.svg
+
+Use figures, if you want also captions::
+
+ .. list-table::
+ :class: borderless
+
+ * - .. figure:: rst/images/title-scaling.svg
+
+ Figure 1/1
+
+ - .. figure:: rst/images/biohazard.svg
+
+ Figure 1/2
+
+.. _list table: docs/ref/rst/directives.html#list-table
+
+
+HTML Writer
+===========
+
+What is the status of the HTML Writer?
+--------------------------------------
+
+The default HTML Writer module, `html4css1`_, is
+a proof-of-concept reference implementation. While it is a complete
+implementation, some aspects of the HTML it produces may be outdated or
+incompatible with older browsers or specialized applications (such as
+web templating).
+
+The `html5 writer`_ generates semantic HTML output compatible with HTML5.
+For the full selection see `Docutils HTML writers`_
+
+.. _html4css1: docs/user/html.html#html4css1
+.. _HTML5 writer: docs/user/html.html#html5
+.. _Docutils HTML writers: docs/user/html.html
+
+
+What browsers are supported?
+----------------------------
+
+No specific browser is targeted; all modern graphical browsers should
+work. Some older browsers, text-only browsers, and browsers without
+full CSS support are known to produce inferior results. Firefox,
+Safari, Opera, Chrome, Edge, and MS Internet Explorer (version 5.0 and up)
+are known to give good results. Reports of experiences with other
+browsers are welcome.
+
+
+Unexpected results from ``rst2html``: H1, H1 instead of H1, H2. Why?
+--------------------------------------------------------------------------
+
+This only regards output from the `html4css1`_ writer and is configurable
+via the initial_header_level_ setting.
+
+.. class:: details
+
+details
+ Here's the question in full:
+
+ I have this text::
+
+ Heading 1
+ =========
+
+ All my life, I wanted to be H1.
+
+ Heading 1.1
+ -----------
+
+ But along came H1, and so shouldn't I be H2?
+ No! I'm H1!
+
+ Heading 1.1.1
+ *************
+
+ Yeah, imagine me, I'm stuck at H3! No?!?
+
+ When I run it through ``rst2html4``, I get unexpected results
+ (below). I was expecting H1, H2, then H3; instead, I get H1, H1,
+ H2::
+
+ ...
+ <html lang="en">
+ <head>
+ ...
+ <title>Heading 1</title>
+ </head>
+ <body>
+ <div class="document" id="heading-1">
+ <h1 class="title">Heading 1</h1> <-- first H1
+ <p>All my life, I wanted to be H1.</p>
+ <div class="section" id="heading-1-1">
+ <h1><a name="heading-1-1">Heading 1.1</a></h1> <-- H1
+ <p>But along came H1, and so now I must be H2.</p>
+ <div class="section" id="heading-1-1-1">
+ <h2><a name="heading-1-1-1">Heading 1.1.1</a></h2>
+ <p>Yeah, imagine me, I'm stuck at H3!</p>
+ ...
+
+ What gives?
+
+ Check the "class" attribute on the H1 tags, and you will see a
+ difference. The first H1 is actually ``<h1 class="title">``; this is
+ the document title, and the default stylesheet renders it centered.
+ There can also be an ``<h2 class="subtitle">`` for the document
+ subtitle.
+
+ If there's only one highest-level section title at the beginning of a
+ document, it is treated specially, as the document title. (Similarly, a
+ lone second-highest-level section title may become the document
+ subtitle.) See `How can I indicate the document title? Subtitle?`_ for
+ details. Rather than use a plain H1 for the document title, we use ``<h1
+ class="title">`` so that we can use H1 again within the document. Why
+ do we do this? HTML only has H1-H6, so by making H1 do double duty, we
+ effectively reserve these tags to provide 6 levels of heading beyond the
+ single document title.
+
+ With "html4css1", HTML is being used for dumb formatting for nothing
+ but final display. A stylesheet *is required*, and one is provided;
+ see `Docutils HTML writers`_. Of course, you're
+ welcome to roll your own. The default stylesheet provides rules to
+ format ``<h1 class="title">`` and ``<h2 class="subtitle">``
+ differently from ordinary ``<h1>`` and ``<h2>``::
+
+ h1.title {
+ text-align: center }
+
+ h2.subtitle {
+ text-align: center }
+
+ If you don't want the top section heading to be interpreted as a
+ title at all, disable the `doctitle_xform`_ setting
+ (``--no-doc-title`` option). This will interpret your document
+ differently from the standard settings, which might not be a good
+ idea. If you don't like the reuse of the H1 in the HTML output, you
+ can tweak the `initial_header_level`_ setting
+ (``--initial-header-level`` option) -- but unless you match its value
+ to your specific document, you might end up with bad HTML (e.g. H3
+ without H2).
+
+ .. _doctitle_xform: docs/user/config.html#doctitle-xform
+ .. _initial_header_level: docs/user/config.html#initial-header-level
+
+ (Thanks to Mark McEahern for the question and much of the answer.)
+
+ .. note:: For the `html5 writer`_, `initial_header_level`_ defaults to
+ ``2`` because this is what the `HTML5 standard`__ expects as
+ start value for headings nested in <section> elements.
+
+ .. Sectioning content elements are always considered subsections of
+ their nearest ancestor *sectioning root* [#]_ or their nearest
+ ancestor element of *sectioning content* [#]_, whichever is nearest,
+ [...]
+
+ .. [#] <blockquote>, <body>, <details>, <dialog>, <fieldset>,
+ <figure>, <td>
+ .. [#] <article>, <aside>, <nav>, <section>
+
+ I.e., a top-level <section> is a subsection of <body>.
+
+ __ https://www.w3.org/TR/html53/sections.html#headings-and-sections
+
+
+How are lists formatted in HTML?
+--------------------------------
+
+If list formatting looks strange, first check that you understand
+`list markup`__.
+
+__ `How should I mark up lists?`_
+
+* By default, HTML browsers indent lists relative to their context.
+ This follows a long tradition in browsers (but isn't so established
+ in print). If you don't like it, you should change the stylesheet.
+
+ This is different from how lists look in reStructuredText source.
+ Extra indentation in the source indicates a blockquote, resulting in
+ too much indentation in the browser.
+
+* A list item can contain multiple paragraphs etc. In complex cases
+ list items are separated by vertical space. By default this spacing
+ is omitted in "simple" lists. A list is simple if every item
+ contains a simple paragraph and/or a "simple" nested list. For
+ example:
+
+ * text
+
+ * simple
+
+ * simple
+ * simple
+
+ * simple
+
+ text after a nested list
+
+ * multiple
+
+ paragraphs
+
+ In this example the nested lists are simple (and should appear
+ compacted) but the outer list is not.
+
+ If you want all lists to have equal spacing, disable the
+ `compact_lists`_ setting (``--no-compact-lists`` option). The
+ precise spacing can be controlled in the stylesheet.
+
+ Note again that this is not exactly WYSIWYG: it partially resembles
+ the rules about blank lines being optional between list items in
+ reStructuredText -- but adding/removing optional blank lines does
+ not affect spacing in the output! It's a feature, not a bug: you
+ write it as you like but the output is styled consistently.
+
+ .. _compact_lists: docs/user/config.html#compact-lists
+
+
+Why do enumerated lists only use numbers (no letters or roman numerals)?
+------------------------------------------------------------------------
+
+The rendering of enumerators (the numbers or letters acting as list
+markers) is completely governed by the stylesheet, so either the
+browser can't find the stylesheet (try enabling the
+`embed_stylesheet`_ setting [``--embed-stylesheet`` option]), or the
+browser can't understand it (try a not too old Firefox, Chrome, Opera,
+Safari, Edge, or even MSIE).
+
+.. _embed_stylesheet: docs/user/config.html#embed-stylesheet
+
+
+There appear to be garbage characters in the HTML. What's up?
+--------------------------------------------------------------
+
+What you're seeing is most probably not garbage, but the result of a
+mismatch between the actual encoding of the HTML output and the
+encoding your browser is expecting. Your browser is misinterpreting
+the HTML data, which is encoded text. A discussion of text encodings
+is beyond the scope of this FAQ; see one or more of these documents
+for more info:
+
+* `UTF-8 and Unicode FAQ for Unix/Linux
+ <http://www.cl.cam.ac.uk/~mgk25/unicode.html>`_
+
+* Chapters 3 and 4 of `Introduction to i18n [Internationalization]
+ <http://www.debian.org/doc/manuals/intro-i18n/>`_
+
+* `Python Unicode Tutorial
+ <http://www.reportlab.com/i18n/python_unicode_tutorial.html>`_
+
+The common case is with the default output encoding (UTF-8), when
+using symbol-footnotes. Most footnote symbols are not available in ASCII.
+When encoded with UTF-8 and viewed with ordinary ASCII tools,
+these characters will appear to be multi-character garbage.
+
+You may have an decoding problem in your browser (or editor, etc.).
+The encoding of the output is set to UTF-8, but your browser isn't
+recognizing that. You can either try to fix your browser (enable
+"UTF-8 character set", sometimes called "Unicode"), or choose a
+different `output-encoding`_. You can also try
+``--output-encoding=ascii:xmlcharrefreplace`` for HTML or XML, but not
+applicable to non-XMLish outputs.
+
+If you're generating document fragments, the "Content-Type" metadata
+(between the HTML ``<head>`` and ``</head>`` tags) must agree with the
+encoding of the rest of the document. For UTF-8, it should be::
+
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+Also, Docutils normally generates an XML declaration as the first line
+of the output. It must also match the document encoding. For UTF-8::
+
+ <?xml version="1.0" encoding="utf-8" ?>
+
+.. _sectnum: docs/ref/rst/directives.html#sectnum
+.. _output-encoding: docs/user/config.html#output-encoding
+
+
+How can I retrieve the body of the HTML document?
+-------------------------------------------------
+
+(This is usually needed when using Docutils in conjunction with a
+templating system.)
+
+You can use the `docutils.core.publish_parts()`_ function, which
+returns a dictionary containing an 'html_body_' entry.
+
+.. _docutils.core.publish_parts(): docs/api/publisher.html#publish-parts
+.. _html_body: docs/api/publisher.html#html-body
+
+
+Why is the Docutils XHTML served as "Content-type: text/html"?
+--------------------------------------------------------------
+
+Full question:
+
+ Docutils' HTML output looks like XHTML and is advertised as such::
+
+ <?xml version="1.0" encoding="utf-8" ?>
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "https://www.w3.org/TR/xht ml1/DTD/xhtml1-transitional.dtd">
+
+ But this is followed by::
+
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+ Shouldn't this be "application/xhtml+xml" instead of "text/html"?
+
+Short answer: if we didn't serve XHTML as "text/html" (which is a
+perfectly valid thing to do), it couldn't be viewed in Internet
+Explorer.
+
+Long answer: In a perfect web, the Docutils XHTML output would be 100%
+strict XHTML. But it's not a perfect web, and a major source of
+imperfection is Internet Explorer. When the "html4css1"
+writer was created, IE represented the overwhelming majority of web
+browsers "in the wild".
+The behaviour is kept for backwards compatibility while
+modern, semantic HTML output is available with the "html5" writer.
+
+(Thanks to Martin F. Krafft, Robert Kern, Michael Foord, and Alan
+G. Isaac.)
+
+
+Python Source Reader
+====================
+
+Can I use Docutils for Python auto-documentation?
+-------------------------------------------------
+
+Yes, in conjunction with other projects.
+
+The Sphinx_ documentation generator includes an autodoc module.
+
+.. _Sphinx: http://www.sphinx-doc.org
+
+Version 2.0 of Ed Loper's `Epydoc <http://epydoc.sourceforge.net/>`_
+supports reStructuredText-format docstrings for HTML output. Docutils
+0.3 or newer is required.
+
+Development of a Docutils-specific auto-documentation tool is suspended.
+
+.. Epydoc works by importing
+ Python modules to be documented, whereas the Docutils-specific tool,
+ described above, will parse modules without importing them (as with
+ `HappyDoc <http://happydoc.sourceforge.net/>`_, which doesn't support
+ reStructuredText).
+
+ The advantages of parsing over importing are security and flexibility;
+ the disadvantage is complexity/difficulty.
+
+ * Security: untrusted code that shouldn't be executed can be parsed;
+ importing a module executes its top-level code.
+ * Flexibility: comments and unofficial docstrings (those not supported
+ by Python syntax) can only be processed by parsing.
+ * Complexity/difficulty: it's a lot harder to parse and analyze a
+ module than it is to ``import`` and analyze one.
+
+ For more details, please see "Docstring Extraction Rules"
+ in :PEP:`258`, item 3 ("How").
+
+
+Miscellaneous
+=============
+
+Is the Docutils document model based on any existing XML models?
+----------------------------------------------------------------
+
+Not directly, no. It borrows bits from DocBook, HTML, and others. I
+(David Goodger) have designed several document models over the years,
+and have my own biases. The Docutils document model is designed for
+simplicity and extensibility, and has been influenced by the needs of
+the reStructuredText markup.
+
+
+.. _contribute:
+
+How to make code contributions that are easily accepted
+-------------------------------------------------------
+
+* Follow the `Python coding conventions`_ and `documentation
+ conventions`_ in the Docutils Policies.
+ Ensure the addition works with all `supported Python versions`_.
+
+ Look at the Docutils sources to see how similar features are
+ implemented, learn to do it "the Docutils way".
+
+* Prepare tests_. Test cases are also examples and showcases for new
+ features.
+
+* Include documentation.
+
+* For larger changes, consider creating a `feature branch`_ in a
+ Docutils repository_ checkout. [#]_
+
+* Mail your patch to the Docutils-develop_ mailing list or attach it to the
+ relevant ticket at Docutils' `bug tracker`_ or `feature request tracker`_.
+ We accept patches created with diff, SVN, or Git.
+
+The developers will make sure that contributions fit nicely into Docutils.
+This might involve discussing (and compromising on) design and
+implementation details. It might also lead to the conclusion that the
+addition fits better in the `extensions and related projects`_.
+
+.. [#] Working with branches is much easier with Git_. You can get a Git
+ clone of the repository from http://repo.or.cz/w/docutils.git or with
+ git-svn.
+
+.. _Python coding conventions: docs/dev/policies.html#python-coding-conventions
+.. _documentation conventions: docs/dev/policies.html#documentation-conventions
+.. _tests: docs/dev/testing.html
+.. _supported Python versions: README.html#requirements
+.. _feature branch: docs/dev/policies.html#feature-branch
+.. _Git: http://git-scm.com/
+.. _bug tracker: https://sourceforge.net/p/docutils/bugs/
+
+
+
+.. Emacs settings
+
+ Local Variables:
+ mode: indented-text
+ mode: rst
+ indent-tabs-mode: nil
+ sentence-end-double-space: t
+ fill-column: 70
+ End:
+
+.. Here's a code css to make a table colourful::
+
+ /* Table: */
+
+ th {
+ background-color: #ede;
+ }
+
+ /* alternating colors in table rows */
+ table.docutils tr:nth-child(even) {
+ background-color: #F3F3FF;
+ }
+ table.docutils tr:nth-child(odd) {
+ background-color: #FFFFEE;
+ }
+
+ table.docutils tr {
+ border-style: solid none solid none;
+ border-width: 1px 0 1px 0;
+ border-color: #AAAAAA;
+ }
Deleted: trunk/docutils/FAQ.txt
===================================================================
--- trunk/docutils/FAQ.txt 2024-08-15 07:31:04 UTC (rev 9905)
+++ trunk/docutils/FAQ.txt 2024-08-15 08:43:38 UTC (rev 9906)
@@ -1,1339 +0,0 @@
-.. include:: docs/header0.txt
-
-.. NOTE TO MAINTAINERS: Please add new questions to the end of their
- sections, so section/question numbers remain stable.
-
-===========================================
- Docutils FAQ (Frequently Asked Questions)
-===========================================
-
-:Date: $Date$
-:Revision: $Revision$
-:Web site: https://docutils.sourceforge.io/
-:Copyright: This document has been placed in the public domain.
-
-.. contents::
-.. sectnum::
-
-
-This is a work in progress. If you are reading a local copy, the
-`master copy`_ might be newer. This document uses relative links;
-if they don't work, please use the master copy.
-
-Please feel free to ask questions and/or provide answers; send email
-to the `Docutils-users`_ mailing list. Project members should feel
-free to edit the source text file directly.
-
-.. _master copy: https://docutils.sourceforge.io/FAQ.html
-.. _let us know:
-.. _Docutils-users: docs/user/mailing-lists.html#docutils-users
-
-
-
-Docutils
-========
-
-What is Docutils?
------------------
-
-Docutils_ is a system for processing plaintext documentation into
-useful formats, such as HTML, XML, and LaTeX. It supports multiple
-types of input, such as standalone files, `PEPs (Python Enhancement
-Proposals)`_, and string input. Client code may add other input types,
-e.g. Sphinx_ comes with an extension to extract inline documentation
-from Python modules and packages.
-
-The Docutils distribution consists of:
-
-* a library (the "docutils" package), which `can be used by client
- code`_;
-* several `front-end tools`_ (such as ``rst2html``, which converts
- reStructuredText input into HTML output);
-* a `test suite`_; and
-* documentation_.
-
-For an overview of the Docutils project implementation,
-see :PEP:`258`, "Docutils Design Specification".
-
-Docutils is implemented in Python_.
-
-.. _Docutils: https://docutils.sourceforge.io/
-.. _PEPs (Python Enhancement Proposals):
- https://peps.python.org/pep-0012
-.. _can be used by client code: docs/api/publisher.html
-.. _front-end tools: docs/user/tools.html
-.. _test suite: docs/dev/testing.html
-.. _documentation: docs/index.html
-.. _Python: https://www.python.org/
-
-
-Why is it called "Docutils"?
-----------------------------
-
-Docutils is short for "Python Documentation Utilities". The name
-"Docutils" was inspired by "Distutils", the Python Distribution
-Utilities architected by Greg Ward, a component of Python's standard
-library.
-
-The earliest known use of the term "docutils" in a Python context was
-a `fleeting reference`__ in a message by Fred Drake on 1999-12-02 in
-the Python Doc-SIG mailing list. It was suggested `as a project
-name`__ on 2000-11-27 on Doc-SIG, again by Fred Drake, in response to
-a question from Tony "Tibs" Ibbs: "What do we want to *call* this
-thing?". This was shortly after David Goodger first `announced
-reStructuredText`__ on Doc-SIG.
-
-Tibs used the name "Docutils" for `his effort`__ "to document what the
-Python docutils package should support, with a particular emphasis on
-documentation strings". Tibs joined the current project (and its
-predecessors) and graciously donated the name.
-
-For more history of reStructuredText and the Docutils project, see `An
-Introduction to reStructuredText`_.
-
-Please note that the name is "Docutils", not "DocUtils" or "Doc-Utils"
-or any other variation. It is pronounced as in "DOCumentation
-UTILitieS", with emphasis on the first syllable.
-
-.. _An Introduction to reStructuredText: docs/ref/rst/introduction.html
-__ https://mail.python.org/pipermail/doc-sig/1999-December/000878.html
-__ https://mail.python.org/pipermail/doc-sig/2000-November/001252.html
-__ https://mail.python.org/pipermail/doc-sig/2000-November/001239.html
-__ http://homepage.ntlworld.com/tibsnjoan/docutils/STpy.html
-
-
-Is there a GUI authoring environment for Docutils?
---------------------------------------------------
-
-See the links to editors_ supporting reStructuredText.
-
-.. _editors: docs/user/links.html#editors
-
-
-What is the status of the Docutils project?
--------------------------------------------
-
-Docutils is mainly stable, with documented APIs and architecture
-subject to change after announcement and a transition period.
-
-We fix bugs as they are reported. This means the code from the
-repository_ (or the snapshots_) is the most stable as well as the most
-featureful most of the time.
-
-
-What is the Docutils project release policy?
---------------------------------------------
-
-Besides the regular releases_, we provide automatically-generated
-snapshots_ which always contain the latest code from the repository_.
-As the project matures, we may formalize on a
-stable/development-branch scheme, but we're not using anything like
-that yet.
-
-.. _releases: https://pypi.org/project/docutils/#history
-.. _snapshots: https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/
-.. _repository: docs/dev/repository.html
-
-
-How can I get a new feature into Docutils?
-------------------------------------------
-
-* Present your idea at the docutils-develop_ mailing list or file a
- ticket at Docutils' `feature request tracker`_.
- Convince the Docutils developers that this is a valuable addition.
-
-* Contribute_.
-
-* Be patient, and be persistent. None of us are paid to do this,
- it's all in our spare time, which is precious and rare.
-
-.. _docutils-develop: docs/user/mailing-lists.html#docutils-develop
-.. _extensions and related projects:
- docs/dev/policies.html#extensions-and-related-projects
-.. _feature request tracker:
- https://sourceforge.net/p/docutils/feature-requests/
-
-
-reStructuredText
-================
-
-What is reStructuredText?
--------------------------
-
-reStructuredText_ is an easy-to-read, what-you-see-is-what-you-get
-plaintext markup syntax and parser system. The reStructuredText
-parser is a component of Docutils_. reStructuredText is a revision
-and reinterpretation of the StructuredText_ and Setext_ lightweight
-markup systems.
-
-If you are reading this on the web, you can see for yourself. `The
-source for this FAQ <FAQ.txt>`_ is written in reStructuredText; open
-it in another window and compare them side by side.
-
-`A ReStructuredText Primer`_ and the `Quick reStructuredText`_ user
-reference are a good place to start. The `reStructuredText Markup
-Specification`_ is a detailed technical specification.
-
-.. _A ReStructuredText Primer: docs/user/rst/quickstart.html
-.. _Quick reStructuredText: docs/user/rst/quickref.html
-.. _reStructuredText Markup Specification:
- docs/ref/rst/restructuredtext.html
-.. _reStructuredText: https://docutils.sourceforge.io/rst.html
-.. _StructuredText:
- http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage/
-.. _Setext: https://docutils.sourceforge.io/mirror/setext.html
-
-
-Why is it called "reStructuredText"?
-------------------------------------
-
-The name came from a combination of "StructuredText", one of
-reStructuredText's predecessors, with "re": "revised", "reworked", and
-"reinterpreted", and as in the ``re.py`` regular expression module.
-For a detailed history of reStructuredText and the Docutils project,
-see `An Introduction to reStructuredText`_.
-
-"reStructuredText" is **ONE** word, *not two!*
-
-
-What's the standard abbreviation for "reStructuredText"?
---------------------------------------------------------
-
-"RST" and "ReST" (or "reST") are both acceptable. Care should be
-taken with capitalization, to avoid confusion with "REST__", an
-acronym for "Representational State Transfer".
-
-The abbreviations "reSTX" and "rSTX"/"rstx" should **not** be used;
-they overemphasize reStructuredText's predecessor, Zope's
-StructuredText.
-
-__ https://en.wikipedia.org/wiki/Representational_State_Transfer
-
-
-What's the standard filename extension for a reStructuredText file?
--------------------------------------------------------------------
-
-It's ".txt". ReStructuredText source files are meant to be readable as
-plaintext, and most operating systems already associate ".txt" with text
-files.
-
-That said, we see an increasing number of projects settling on
-the extension ".rst".
-
-Also see `What's the official MIME type for reStructuredText data?`_
-
-
-Are there any reStructuredText editor extensions?
--------------------------------------------------
-
-See the list of editors_ supporting reStructuredText.
-
-
-How can I indicate the document title? Subtitle?
--------------------------------------------------
-
-A uniquely-adorned section title at the beginning of a document is
-treated specially, as the document title. Similarly, a
-uniquely-adorned section title immediately after the document title
-becomes the document subtitle. For example::
-
- This is the Document Title
- ==========================
-
- This is the Document Subtitle
- -----------------------------
-
- Here's an ordinary paragraph.
-
-Counterexample::
-
- Here's an ordinary paragraph.
-
- This is *not* a Document Title
- ==============================
-
- The "ordinary paragraph" above the section title
- prevents it from becoming the document title.
-
-Another counterexample::
-
- This is not the Document Title, because...
- ===========================================
-
- Here's an ordinary paragraph.
-
- ... the title adornment is not unique
- =====================================
-
- Another ordinary paragraph.
-
-
-How can I represent esoteric characters (e.g. character entities) in a document?
---------------------------------------------------------------------------------
-
-For example, say you want an em-dash (XML character entity —,
-Unicode character U+2014) in your document: use a real em-dash.
-Insert literal characters (e.g. type a *real* em-dash) into your
-input file, using whatever encoding suits your application, and tell
-Docutils the input encoding. Docutils uses Unicode internally, so the
-em-dash character is U+2014 internally.
-
-Emacs users should refer to the `Emacs Support for reStructuredText`__
-document. Tips for other editors are welcome.
-
-__ tools/editors/emacs/README.html
-
-ReStructuredText has no character entity subsystem; it doesn't know
-anything about XML character entities.
-To Docutils, "—" in input text is
-7 discrete characters; no interpretation happens. When writing HTML,
-the "&" is converted to "&", so in the raw output you'd see
-"&mdash;". There's no difference in interpretation for text
-inside or outside inline literals or literal blocks -- there's no
-character entity interpretation in either case.
-
-If you can't use a Unicode-compatible encoding and must rely on 7-bit
-ASCII, there is a workaround:
-`Standard Substitution Definition Sets`_ provide equivalents of
-XML & HTML character entity sets as substitution definitions. [#]_
-For example, the Japanese yen currency symbol can be used as follows::
-
- .. include:: <xhtml1-lat1.txt>
-
- |yen| 600 for a complete meal? That's cheap!
-
-.. [#] Thanks to David Priest for the original idea.
-
-You can create custom `substitution definitions`_ in your document
-using the "unicode_" directive, e.g.::
-
- .. |--| unicode:: U+2013 .. en dash
- .. |---| unicode:: U+2014 .. em dash, trimming surrounding whitespace
- :trim:
-
-.. |--| unicode:: U+2013 .. en dash
-.. |---| unicode:: U+2014 .. em dash, trimming surrounding whitespace
- :trim:
-
-Now you can write dashes using pure ASCII: "``foo |--| bar; foo |---|
-bar``", rendered as "foo |--| bar; foo |---| bar".
-The ``:trim:`` option for
-the em dash is necessary because you cannot write "``foo|---|bar``";
-thus you need to add spaces ("``foo |---| bar``") and advise the
-reStructuredText parser to trim the spaces.
-
-.. _Standard Substitution Definition Sets: docs/ref/rst/definitions.html
-.. _substitution definitions: docs/ref/rst/restructuredtext.html
- #substitution-definitions
-.. _unicode: docs/ref/rst/directives.html#unicode-character-codes
-
-
-How can I generate backticks using a Scandinavian keyboard?
------------------------------------------------------------
-
-The use of backticks in reStructuredText is a bit awkward with
-Scandinavian keyboards, where the backtick is a "dead" key. To get
-one ` character one must press SHIFT-` + SPACE.
-
-Unfortunately, with all the variations out there, there's no way to
-please everyone. For Scandinavian programmers and technical writers,
-this is not limited to reStructuredText but affects many languages and
-environments.
-
-Possible solutions include
-
-* If you have to input a lot of backticks, simply type one in the
- normal/awkward way, select it, copy and then paste the rest (CTRL-V
- is a lot faster than SHIFT-` + SPACE).
-
-* Use keyboard macros.
-
-* Remap the keyboard. The Scandinavian keyboard layout is awkward for
- other programming/technical characters too; for example, []{}
- etc. are a bit awkward compared to US keyboards.
-
- According to Axel Kollmorgen,
-
- Under Windows, you can use the `Microsoft Keyboard Layout Creator
- <http://www.microsoft.com/globaldev/tools/msklc.mspx>`__ to easily
- map the backtick key to a real backtick (no dead key). took me
- five minutes to load my default (german) keyboard layout, untick
- "Dead Key?" from the backtick key properties ("in all shift
- states"), "build dll and setup package", install the generated
- .msi, and add my custom keyboard layout via Control Panel >
- Regional and Language Options > Languages > Details > Add
- Keyboard layout (and setting it as default "when you start your
- computer").
-
-* Use a virtual/screen keyboard or character palette, such as:
-
- - `Web-based keyboards <http://keyboard.lab.co.il/>`__ (IE only
- unfortunately).
- - Windows: `Click-N-Type <http://www.lakefolks.org/cnt/>`__.
- - Mac OS X: the Character Palette can store a set of favorite
- characters for easy input. Open System Preferences,
- International, Input Menu tab, enable "Show input menu in menu
- bar", and be sure that Character Palette is enabled in the list.
-
-If anyone knows of other/better solutions, please `let us know`_.
-
-
-Are there any tools for HTML/XML-to-reStructuredText? (Round-tripping)
------------------------------------------------------------------------
-
-People have tossed the idea around, and some implementations of
-reStructuredText-generating tools can be found in the `Docutils Link
-List`_.
-
-There's no reason why reStructuredText should not be round-trippable
-to/from XML; any technicalities which prevent round-tripping would be
-considered bugs. Whitespace would not be identical, but paragraphs
-shouldn't suffer. The tricky parts would be the smaller details, like
-links and IDs and other bookkeeping.
-
-For HTML, true round-tripping may not be possible. Even adding lots
-of extra "class" attributes may not be enough. A "simple HTML" to RST
-filter is possible -- for some definition of "simple HTML" -- but HTML
-is used as dumb formatting so much that such a filter may not be
-particularly useful. An 80/20 approach should work though: build a
-tool that does 80% of the work automatically, leaving the other 20%
-for manual tweaks.
-
-.. _Docutils Link List: docs/user/links.html
-
-
-Are there any Wikis that use reStructuredText syntax?
------------------------------------------------------
-
-There are several, with various degrees of completeness. With no
-implied endorsement or recommendation, and in no particular order:
-
-* `Ian Bicking's experimental code
- <https://docutils.sourceforge.io/sandbox/ianb/wiki/Wiki.py>`__
-
-* `MoinMoin <http://moinmoin.wikiwikiweb.de/>`__ has some support;
- `here's a sample <http://moinmoin.wikiwikiweb.de/RestSample>`__
-
-* Zope-based `Zwiki <http://zwiki.org/>`__
-
-* Zope3-based Zwiki (in the Zope 3 source tree as
- ``zope.products.zwiki``)
-
-* `StikiWiki <http://mithrandr.moria.org/code/stikiwiki/>`__
-
-* `Trac <http://trac.edgewall.com//>`__ `supports using
- reStructuredText
- <http://trac.edgewall.com//wiki/WikiRestructuredText>`__ as
- an alternative to wiki markup. This includes support for `TracLinks
- <http://trac.edgewall.com//wiki/TracLinks>`__ from within
- RST text via a custom RST reference-directive or, even easier, an
- interpreted text role 'trac'
-
-Please `let us know`_ of any other reStructuredText Wikis.
-
-.. dead link
-.. The example application for the `Web Framework Shootout
-.. <http://colorstudy.com/docs/shootout.html>`__ article is a Wiki using
-.. reStructuredText.
-
-
-Are there any Weblog (Blog) projects that use reStructuredText syntax?
-----------------------------------------------------------------------
-
-With no implied endorsement or recommendation, and in no particular
-order:
-
-* `Firedrop <http://www.voidspace.org.uk/python/firedrop2/>`__
-* `PyBloxsom <http://pyblosxom.github.io/>`__
-* `Lino WebMan <http://lino.sourceforge.net/webman.html>`__
-* `Pelican <http://blog.getpelican.com/>`__
- (also listed `on PyPi <http://pypi.python.org/pypi/pelican>`__)
-
-Please `let us know`_ of any other reStructuredText Blogs.
-
-
-.. _Can lists be indented without generating block quotes?:
-
-How should I mark up lists?
----------------------------
-
-Bullet_ & enumerated_ list markup is very intuitive but there are 2
-points that must be noted:
-
-.. _bullet: docs/ref/rst/restructuredtext.html#bullet-lists
-.. _enumerated: docs/ref/rst/restructuredtext.html#enumerated-lists
-
-1. Lists should **not** be indented. This is correct::
-
- paragraph
-
- * list item 1
-
- * nested item 1.1
- * nested item 1.2
-
- * list item 2
-
- while this is probably incorrect::
-
- paragraph
-
- * list item 1
-
- * nested item 1.1
- * nested item 1.2
-
- * list item 2
-
- The extra indentation (of the list containing items 1.1 and 1.2) is
- recognized as a block quote. This is usually not what you mean and
- it causes the list in the output to be indented too much.
-
-2. There **must** be blank lines around list items, except between
- items of the same level, where blank lines are optional. The
- example above shows this.
-
-Note that formatting of the *output* is independent of the input, and
-is decided by the writer and the stylesheet. For instance, lists
-*are* indented in HTML output by default. See `How are lists
-formatted in HTML?`_ for details.
-
-
-Could lists be indented without generating block quotes?
---------------------------------------------------------
-
-Some people like to write lists with indentation but don't intend a
-blockquote context. There has been a lot of discussion about allowing
-this in reStructuredText, but there are some issues that would need to
@@ Diff output truncated at 100000 characters. @@
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
_______________________________________________
Docutils-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/docutils-checkins