summaryrefslogtreecommitdiff
path: root/docutils/docs
Commit message (Collapse)AuthorAgeFilesLines
* Add a small backwards compatibility script for rst2odt_prepstyles.py.milde2023-05-161-12/+14
| | | | | | | This way, users can adapt to the new command before the "tools/*.py" scripts are no longer installed in Docutils 0.21. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9387 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation fix.milde2023-05-132-5/+15
| | | | | | | Fix internal links in "directives" doc. Add links to description of differences between html4css1 and html5 writers. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9385 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* note on getting a fresh chcekout for release.grubert2023-05-111-2/+7
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9382 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* reminder to check for spurious html files grubert2023-05-101-0/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9381 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* version 0.20.1b.devgrubert2023-05-091-1/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9376 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update.milde2023-05-031-68/+68
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9370 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Revert addition of `io.OutString` and the "auto_encode" argument.milde2023-05-022-54/+71
| | | | | | | We need a review of the "string output" interface and a consensus on the "clean" end-state before starting with the implementation. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9369 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Add output encoding error handler to the parts provided by all writers.milde2023-04-281-1/+4
| | | | | | | | | | | | The new generic part "errors" returned by default contains the `output_encoding_error_handler` setting, which may make-or-break encoding ``parts['whole']``. Allows use of `core.publish_parts()` to get the document as `str`, post-process it and encode with user configurated encoding and encoding-error handler. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9368 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation fix/update.milde2023-04-261-3/+8
| | | | | | | | The return value of `io.FileOutput` (and hence of `core.publish_cmdline()` and `core.publish_file()`) is a `str` instance (except for binary output document formats) and has always been under Python 3. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9366 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Next iteration of "directives" documentation refactoring.milde2023-04-201-83/+141
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9361 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Review rST "directives" documentation.milde2023-04-191-56/+63
| | | | | | | | Unify content type descriptions. Add cross-links. Reword for better clarity. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9359 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update documentation for the "csv-table" directive.milde2023-04-182-28/+50
| | | | | | | | | Document current behaviour and the roadmap to bring it in line with the specification. Add deprecation warnings for to-be-removed objects. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9356 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Announce change of "math-output" setting default for HTML5 to "MathML".milde2023-04-142-55/+54
| | | | | | | | | | MathML is supported by Chrome since January 2023. Use MathML in documentation pages generated with the HTML5 writer already now. Update "LaTeX syntax for mathematics" documentation. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9347 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Do not decode OpenDocument zip packages with `publish_string()`.milde2023-04-132-36/+43
| | | | | | | | | | | | | | The ODF writer produces output in binary format. Raise an exception if `publish_string()` is called with this writer and ``auto_encode=False``. Update documentation, add cross-links. TODO: In future, the ODF writer may return a "flat XML" version of the "OpenDocument Text" document as `str`. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9345 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix typo.milde2023-04-121-2/+2
| | | | | | Reported by Adam Turner. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9344 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update Publisher API documentation. Add links.milde2023-04-121-26/+51
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9343 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update "Publisher" documentation.milde2023-04-082-122/+167
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9340 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* LaTeX to MathML: fix ``\mspace``.milde2023-04-081-1/+1
| | | | | | | LaTeX width unit "mu" (mathematical unit) must be converted for MathML. Typo in the code resulted in wrong "width" argument for `<mspace>`. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9338 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* New general setting "output".milde2023-02-071-0/+15
| | | | | | | | This setting obsoletes the positional argument <destination>. Cf. the announcement of command line pattern changes in the RELEASE-NOTES. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9328 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Announce command-line usage pattern change.milde2023-02-071-2/+8
| | | | | | Cf. [feature-requests:#36]. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9327 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update documentation on planned changes.milde2023-02-061-2/+4
| | | | | | | | Announce target versions for imminent changes. Announce raise of required minimal Python version to 3.9. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9326 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* New functions for use as `rst2*` "console_scripts entry points".milde2023-02-061-9/+8
| | | | | | | | | | | | | | The new functions allow the installation of `rst2*` command line scripts via standard `entry points`__ instead of the current "scripts" list in ``setup.py`` after a transition period (cf. [feature-requests:#88]). + Works also for Windows. + Allows shorter command names (drop the extension), already in use in Debian and Ubuntu. __ https://packaging.python.org/en/latest/specifications/entry-points/ git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9325 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* More user-friendly DocInfo transform.milde2023-01-171-5/+12
| | | | | | | | | | | | | More detailled feedback when extracting data from a bibliographic field fails. In bibliographic fields expecting a single paragraph (e.g. "author"), restore enumerated lists originating in ambiguous markup like "A. Einstein" (name with initial): in the given context, an we know that this should not be an enumeration, so fixing is better than throwing an error. Fix some cases of "ersatz" Boolean values from pre Python 2.3 times. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9322 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Always use POSIX path in macros loading stylesheets.milde2023-01-161-1/+3
| | | | | | Thanks to Alan G. Isaac for reporting the bug and proposing a patch. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9316 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Policy change: accept literal Unicode characters except for identifiers.milde2023-01-101-9/+5
| | | | | | | | With UTF-8 as default encoding for Python source code and widespread Unicode support in todays editors on all platforms, there is no need to be more restrictive than PEP 8 any more. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9313 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix [bugs:#384]: allow omission of citations with "use_bibtex" setting.milde2022-12-191-6/+10
| | | | | | | | | | | | | | | | | | | If the "use_bibtex" LaTeX writer setting is active (i.e. not empty), citations are added by LaTeX/BibTeX from a database for all citation references in the document. The reference resolver transform now skips `citation_reference` nodes instead of expecting matching `citation` nodes in this case. "use_bibtex" content is now transformed to a list by the `frontend.validate_comma_separated_list()` validator. As BibTeX works only with "LaTeX citations", the "use_latex_citations" setting is set to True whenever "use_bibtex" is not empty. Update documentation. The test function, added in the last commit, now passes. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9312 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update Publisher API documentation.milde2022-12-132-20/+76
| | | | | | | | | | | | Use Python 3 terminology: "Unicode string" -> `str` instance. Document "string I/O" (input/output using `str` or `bytes` instances). Document input encoding auto-detection. Specify the behaviour and the "explicit encoding declaration". git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9309 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update test documentation. Set executable bit on test scripts.milde2022-12-131-8/+8
| | | | | | | | | | | Don't mention the "nose" test framework. (It is unmaintained, deprecated, and fails to find all test cases.) Hint to a possible future dependency on "pytest". Two recently added test scripts missed the executable bit. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9308 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update test documentation.milde2022-12-021-51/+42
| | | | | | | Add links. Adapt to the changes during the recent refactoring. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9299 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* The "xetex" writer now ignores settings in the [latex2e writer] config section.milde2022-12-011-6/+6
| | | | | | | Move settings intended for both, `xetex` and `latex2e` writers to section [latex writers]. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9293 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Raise version to 0.20b.dev.milde2022-12-011-17/+21
| | | | | | There are not only bugfix changes since 0.19, so a new "minor" release is required. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9291 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update documentation.milde2022-12-012-42/+38
| | | | | | | | | | Simplify/update instructions for installing, Simplify/update instructions for building docs (there is now an up-to-date docutils.conf in the "docutils root" archive path. Update links. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9290 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Add anchors to future, ".py"-less front-end commands to "tools" documentation.milde2022-12-011-0/+6
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9287 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small documentation fixes and updates.milde2022-11-283-42/+47
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9281 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Add navigation links to the documentation in the "Docutils root" directory.milde2022-11-281-0/+14
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9280 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update FAQ, add TODO-list example.milde2022-11-251-0/+154
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9276 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix running of individual test (first batch).milde2022-11-241-2/+2
| | | | | | | | | | | | | | | | | | After test refactoring, test scripts failed with ImportError unless started from the "test root" ``docutils/test/``. Prepend the "docutils root" to the Python library path so we import the local `docutils` and `test` packages, ignoring an eventually installed Docutils package. Set executable bit where this was missing. Also: Use "pathlib" instead of "os.path" for self-documenting path manipulations. Remove duplicate ``import unittest`` statements. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9263 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small documentation fixes.milde2022-11-211-2/+2
| | | | | | | | | | | transforms.txt: Update "added by" in "Transforms Listed in Priority Order". io.py: reword docstrings and assertion messages, use PEP 257 "Docstring Conventions". git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9259 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation updatemilde2022-11-183-47/+51
| | | | | | | | | | | | | | | | dev/hacking: Format example code as script rather than as console log (enables easier use via drag-and-drop). Hint to the "quicktest" development tool. Add links. user/config: Fix legacy-lass-functions default change warning. user/toos: Simplify description of the generic front end. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9255 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Add support for ``pytest``aa-turner2022-11-101-6/+6
| | | | | | | | | | | | This is the minimal configuration required for the test suite to pass using the pytest framework. This is part of the test suite refactoring project. - Ignore two classes that start with the word "Test" - Provide the standard test header to pytest - Update the documentation git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9237 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix/complement publisher documentation and tests.milde2022-11-101-8/+21
| | | | | | | | | | | | | | | | | | | | | | | API documentation: - Spell out ampersand (&) as "and". - Finish description of part "pepnum". - Add links to LaTeX templates. - Remove trailing whitespace. Docstrings: - Clarify source and output data type for functions using "string I/O" (with "string" in the general sense of "`str` or `bytes`"). - Recommend using publish_parts() to get Docutils output as `str`. - Add "()" to functions so that pydoc HTML rendering generates auto-links. - Add links to the HTML documentation. Tests: - Add test for input/output data types of publish_string(). git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9235 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update/clarify documentation/docstrings.milde2022-11-071-0/+4
| | | | | | | | | | After dropping support for Python2, we can use the datatype named `bytes` and `str` for encoded strings and Unicode strings respectively. Use the "summary line + optional explanations" style mandated in the "Docstring Conventions" (PEP 257). git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9221 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Support `pandoc` as an external LaTeX to MathML converter.milde2022-11-041-0/+4
| | | | | | Patch by Ximin Luo [patches:#197]. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9216 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* MathML: support "mod" notation for modulo operation/arithmetic.milde2022-11-041-21/+37
| | | | | | TeX to HTML/css support still missing, cf. [feature-requests:#93]. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9213 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Move ``quicktest`` to ``tools/dev``aa-turner2022-11-023-32/+3
| | | | | | | | | | The quicktest tool has not been substantively modified since 2006. It may still be useful for generating test-cases, so move it to the developer tools section and do not advertise it as a front-end tool. Update documentation where relevant to remove mention of quicktest as a front-end tool, and remove obsolete "EasyDialogs" code path. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9201 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Use the Docutils Python API in ``dev/hacking``.aa-turner2022-10-271-6/+14
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9178 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation fix [bug#454].milde2022-09-132-2/+2
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9124 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation fixes.milde2022-09-133-18/+25
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9121 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Improve internationalisation documentationmilde2022-07-292-48/+102
| | | | | | | | | Add links to documentation of translated terms. Sort mappings to better match documentation and keep related terms together. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9118 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Cleanup.milde2022-07-282-4/+4
| | | | | | | | Fix typo. Remove spurious whitespace. Bare "except" replaced with ``except Exception``. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9115 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
View Lorry Controller Status