summaryrefslogtreecommitdiff
path: root/docutils/docs/ref
Commit message (Collapse)AuthorAgeFilesLines
* Documentation fix.milde2023-05-131-4/+6
| | | | | | | 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
* 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-181-27/+47
| | | | | | | | | 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-15/+17
| | | | | | | | | | 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
* 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
* 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
* 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
* Documentation fixes.milde2022-09-132-12/+18
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9121 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Improve internationalisation documentationmilde2022-07-291-38/+78
| | | | | | | | | 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
* Update directives documentationmilde2022-07-282-60/+59
| | | | | | | | | * Clarify the admonitions documentation (fixes bug #453). * Provide hyperlink targets (anchors) for all directive names. (Use anonymous targets for like-named "doctree" elements.) git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9112 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation updatesmilde2022-07-061-13/+13
| | | | | | | | | | 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
* Announce use of dpub-ARIA role "doc-footnote"milde2022-06-191-10/+12
| | | | | | | | instead of ARIA role "note" for footnotes in Docutils 0.20. Cf. [bugs:#450]. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9080 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation updatemilde2022-06-171-9/+3
| | | | | | | | | | | | 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
* Minor documentation updatemilde2022-04-291-32/+39
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9055 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Minimalistic menu bar for documentation pages.milde2022-04-027-0/+14
| | | | 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-012-209/+2
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9050 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update PEP URLs.milde2022-03-132-2/+2
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9044 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update documentation of the "table" directive's "widths" option.milde2022-02-111-5/+12
| | | | | | | The default behaviour of the "html5" writer resembles ``:widths: auto`` since Docutils 0.18. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9008 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix trailing whitespace (non-Python files).milde2022-01-291-1/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8995 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Do not use combining Unicode characters without base in literal strings.milde2022-01-271-3/+7
| | | | | | | Add an example for LaTeX accent functions in mathematical text to the mathematics documentation. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8986 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update URLs in the docs.milde2022-01-217-68/+65
| | | | | | | | 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-205-19/+19
| | | | | | Patch by Adam Turner. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8956 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Add/update link to time.strftime().milde2022-01-201-1/+3
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8952 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update.milde2022-01-041-3/+4
| | | | | | | | | | | | | | | | | | * Small clarification in the rST spec. * Move detailled description of alternative ways to install for development from the "Docutils policies" to the "repository" documentation. We don't need to go into details in the "policies" document and "edible installs" are also useful for casual contributors or power-users. * Update links and optional dependencies in the README, use terminology from PEP 621. Move the sandbox snapshot download doc to the sandbox README. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8929 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small documentation updates and fixes.milde2021-12-231-3/+3
| | | | | | | Also change the priority of the SmartQuotes transform to a level not already in use. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8912 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix and document attribute definitions in nodes.Element.milde2021-11-161-3/+3
| | | | | | | | | | | | Reword documentation using the nomenclature from "expose_internals" in config.txt: External attributes correspond to the XML element attributes. Internal attributes are Python class attributes. Bugfix: Remove the "internal" attribute `rawsource` from `Element.known_attributes` (common external attributes). This was a leftover from [r8194]. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8890 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update documentation and handling of (east-asian) wide characters.milde2021-11-141-3/+10
| | | | | | | | | | | | Explain the special casing for combinging and wide characters in section titles. cf. bug #433 Simplify import (we don't need to care for missing `unicodedata.east_asian_width` in Python < 2.4 any longer). git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8886 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Document image formats, small documentation fixes and updates.milde2021-11-091-6/+38
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8883 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* rST specification fixmilde2021-10-311-4/+5
| | | | | | | | Small fix for the description of option list syntax. Thanks to Mickey Endito for reporting. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8872 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix spellingmilde2021-10-226-12/+12
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8860 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation clarification.milde2021-10-121-13/+26
| | | | | | | Definition list terms starting with a hyphen need escaping. Report by Pierre Ossman. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8850 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* HTML5: New default for table column widths (fixes bug #426).milde2021-10-011-0/+2
| | | | | | | | | Only specify table column widths, if the "widths" option is set and is not "auto". The `table_style`_ setting "colwidths-grid" restores the current default. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8836 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* LaTeX writer: New algorithm for table colum widths. Fixes bug #422.milde2021-09-302-14/+22
| | | | | | | | | | | | New configuration setting "legacy_column_widths" for backwards compatibility. Only write "continued on next page..." if it fits without making the table columns wider. Table `width` option overrides conflicting "auto" column `widths`. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8835 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation updatemilde2021-09-242-148/+122
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8833 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update.milde2021-09-212-899/+736
| | | | | | Expand, condense, and correct the Guide to the Docutils DTD. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8832 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Add "class" option to "raw" directive.milde2021-09-111-1/+4
| | | | | | | | Classe values may already be specified via a preceding "class" directive. This commit provides the concise alternative known from other directives. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8821 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small documentation update.milde2021-08-111-6/+5
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8809 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* LaTeX writer: Refactor computation of table column widths.milde2021-08-101-8/+9
| | | | | | | | | Prepare for fixes (cf. bug #422). Update documentation. No change to the output. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8806 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* MathML: fixes and additions.milde2021-08-101-16/+94
| | | | | | | | | | | | | | | | | | | | Math accent commands more similar to their LaTeX behaviour. Additions for HTML export. Use boolean values for boolean node arguments. Downcase node arguments before storing. Use class argument "boldsymbol" for \boldsymbol content. Alignment of multi line equations similar to AMS-LaTeX "align" environment. Add space after bracket in "cases" environment, left-align columns. Fix spacing before "unary" minus. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8805 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small documentation fixes and additions.milde2021-07-121-3/+65
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8801 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* math.css: tweak bigoperator size.milde2021-07-121-8/+8
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8800 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Math: fix some LaTeX character mappings.milde2021-07-121-50/+48
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8799 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* math2html: Prefer STIX fonts for formulas.milde2021-07-121-9/+20
| | | | | | | | | | | | | | STIX is free, widely supported, and comprehensive. (On the downside: it is considerably smaller than DejaVu: no problem with Chromium/Chrome but in Firefox a larger font-size might be advised.) Work around bugs/problems in STIX: "medium mathematical space" is too wide, "vertical line" glyphs leave gaps when stacked, upright integrals provide better alignment of limits. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8798 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* math2html: Improve handling of big symbols.milde2021-07-121-0/+1
| | | | | | | | | | Scale variable sized operators with CSS instead of constructing from pieces. Fix Unicode translations for N-ary operators. Scale stretch big delimiters instead of scaling. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8796 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* math2html: support small symbols, refactor math accent handling.milde2021-07-121-1/+0
| | | | | | | | | | | | | | | math accents/combining characters: - insert combining character after first character of argument (mimic LaTeX behaviour). - support non alphabetical base-character (\not{\in} and similar). - use precomposed characters if possible (normalization) Cleanup: update comments, remove not required code. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8794 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Major rework of math2html converter.milde2021-07-121-1/+1
| | | | | | | | | | | | | Fork from elyxer (https://github.com/alexfernandez/elyxer). Remove code that is not requried for math conversion. Fix/update LaTeX/Unicode character translation, use common codebase with MathML. Support more commands. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8793 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Doctree documentation fixes.milde2021-06-251-42/+46
| | | | | | | Fix typos, add links. Reword/clarify "footnote" description. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8778 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* HTML5: small fixes, preparation for footnote handling refactoring.milde2021-06-251-6/+17
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8772 929543f6-e4f2-0310-98a6-ba3bd3dd1d04