summaryrefslogtreecommitdiff
path: root/docutils/docs/user
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-131-1/+9
| | | | | | | 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
* 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-021-1/+1
| | | | | | | 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
* Update documentation for the "csv-table" directive.milde2023-04-181-1/+3
| | | | | | | | | 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-141-40/+37
| | | | | | | | | | 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
* 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
* 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
* 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-131-2/+4
| | | | | | | | | | | | 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
* 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
* 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-281-1/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9281 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
* Documentation updatemilde2022-11-182-20/+19
| | | | | | | | | | | | | | | | 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
* 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
* Move ``quicktest`` to ``tools/dev``aa-turner2022-11-021-30/+2
| | | | | | | | | | 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
* 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-131-6/+7
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9121 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation updatesmilde2022-07-064-28/+45
| | | | | | | | | | Document future changes regarding front-end tools. Clarify/update planned changes to the input-encoding handling. Various smaller fixes. Add links. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9107 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update.milde2022-06-201-11/+22
| | | | | | | | Add a warning about use of Python's default encoding by "quicktest.py". Add cross-links, condense. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9082 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation updatemilde2022-06-171-18/+16
| | | | | | | | | | | | Remove dead link and outdated footnote about limitations in Python2. Add link to acceptable values of encoding error handlers. Harmonise help output. Use UTF-8 in prose text, error messages, and documentation. Use 'utf-8' in code or when referring to code. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9077 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Add encoding arguments when opening files.milde2022-06-151-8/+3
| | | | | | | | | | | | | Specify intended incoding, when possible. Avoids `EncodingWarning` in PEP 597 and nasty surprises if the default encoding is not what the user expects. Keep encoding unspecified where this may be an API change. Based on patch by Adam Turner. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9072 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Document planned switch of the default HTML writer in Docutils 2.0.milde2022-06-142-8/+10
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9071 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small documentation fixes and updates.milde2022-06-132-7/+16
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9069 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Postpone deprecations to Docutils 2.0milde2022-05-301-1/+1
| | | | | | | Starting in 1.0, we want to move to "semantic versioning": no incompatible API changes in "minor" releases. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9062 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Command line "entry point" to the docutils package. Part 2/2.milde2022-05-302-23/+23
| | | | | | | | | | | | | | Support ``python -m docutils`` with new module `docutils.__main__`. Support ``docutils`` CLI command via "entry point" in setup.py. Keep tools/docutils-cli.py for backwards compatibility and manual installation. Calls `docutils.__main__.main()`. Thanks to Adam Turner for contributions and review. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9061 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation tweaks.milde2022-05-301-1/+1
| | | | | | | | | | Add link to manpage writer documentation in doc index. Add link to manpage writer references. More consistent formatting of function names in HISTORY. Small additions. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9059 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix typo in indirect hyperlink.milde2022-05-071-1/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9058 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Minimalistic menu bar for documentation pages.milde2022-04-0211-1/+22
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9051 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update and re-organisation.milde2022-04-011-3/+35
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9050 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update PEP base URL and template.milde2022-03-131-1/+1
| | | | | | | | | | | | | | The canonical PEP base URL changed to "peps.python.org/". The PEP-writer template.txt added a "source" link that no longer works due to sources now only be stored on github and having two possible file extensions ("txt" or "rst"). Adapt the header to resemble the header of official PEP documents (which are now produced using Sphinx). Fixes [bug:#445]. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9045 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update PEP URLs.milde2022-03-131-1/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9044 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update public API proposal.milde2022-02-231-2/+6
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9012 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update documentation.milde2022-02-081-3/+14
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9004 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small fixes, mostly documentation. Test more "list" settings.milde2022-02-051-2/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8998 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix trailing whitespace (non-Python files).milde2022-01-296-24/+23
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8995 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Leftovers and fixes after the big clean-up.milde2022-01-271-2/+2
| | | | | | Patch set by Adam Turner. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8985 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update URLs in the docs.milde2022-01-2112-146/+138
| | | | | | | | Mostly http: -> https:, based on a patch by Adam Turner Remove/update some dead links. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8959 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Change http://docutils.sourceforge.net -> https://docutils.sourceforge.iomilde2022-01-208-18/+18
| | | | | | Patch by Adam Turner. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8956 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* More changes to https://sourceforge.netmilde2022-01-204-7/+7
| | | | | | Patch by Adam Turner git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8955 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Change http://docutils.sf.net -> https://docutils.sourceforge.iomilde2022-01-206-17/+17
| | | | | | Patch by Adam Turner. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8954 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Add/update link to time.strftime().milde2022-01-201-3/+2
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8952 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Refer to the "pycmark" CommonMark parser and other documentation fixes.milde2022-01-111-13/+33
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8942 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Remove lingering references to Python 2.milde2022-01-062-6/+1
| | | | | | Based on Patch 1/6 by Adam Turner (patches #188). git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8934 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
View Lorry Controller Status