From: <gr...@us...> - 2024-08-15 08:43:44
|
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: go...@py... +: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: go...@py... -: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: go...@py... +: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: go...@py... -: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... [truncated message content] |