summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Remove dead link.milde2022-06-221-5/+5
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9092 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Wheels are no longer "universal" after dropping Py2.7 support.milde2022-06-221-5/+5
| | | | | | Cf. https://wheel.readthedocs.io/en/stable/user_guide.html git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9090 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* note on --pregrubert2022-06-211-1/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9084 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Add note on manual editing __version_info__ tuplegrubert2022-06-211-0/+2
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9083 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update.milde2022-06-202-13/+24
| | | | | | | | 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/docutils@9082 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/docutils@9080 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation updatemilde2022-06-172-27/+19
| | | | | | | | | | | | 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/docutils@9077 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Command line encoding is now handled by Python.milde2022-06-171-21/+0
| | | | | | | | Replacing the auto-decoding by Python 3 with a home-baked approach is not worth the effort, so I retract this TODO suggestion. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9076 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/docutils@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/docutils@9071 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small documentation fixes and updates.milde2022-06-133-10/+19
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@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/docutils@9062 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Command line "entry point" to the docutils package. Part 2/2.milde2022-05-303-63/+24
| | | | | | | | | | | | | | 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/docutils@9061 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation tweaks.milde2022-05-303-2/+20
| | | | | | | | | | 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/docutils@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/docutils@9058 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Minor documentation updatemilde2022-04-291-32/+39
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9055 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Minimalistic menu bar for documentation pages.milde2022-04-0243-6/+121
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9051 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update and re-organisation.milde2022-04-018-131/+151
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@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/docutils@9045 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update PEP URLs.milde2022-03-136-10/+10
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9044 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* core.Publisher.publish(): Prompt when waiting for input from a terminal.milde2022-03-111-0/+10
| | | | | | | | | | | | | | When front-end tools are used without arguments, Docutils reads from stdin. Currently, when a user calls a front-end without arguments, there is no response until the user presses Ctrl-D (Ctrl-Z on Windows) or aborts with Ctrl-C. This commit changes the behaviour to tell the user what the front-end expects and where to get more help. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9043 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation fixes/clarifications.milde2022-03-033-91/+89
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9014 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/docutils@9012 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/docutils@9008 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Add "manpage" writer documentation to documentation index.milde2022-02-101-1/+2
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9007 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update documentation.milde2022-02-081-3/+14
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@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/docutils@8998 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update the Runtime Settings API documentation.milde2022-02-033-184/+518
| | | | | | | | | Update API documentation. Split implementation details into a separate document for core developers. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8996 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix trailing whitespace (non-Python files).milde2022-01-2913-39/+38
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@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/docutils@8986 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/docutils@8985 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update URLs in the docs.milde2022-01-2129-324/+301
| | | | | | | | 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/docutils@8959 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Change http://docutils.sourceforge.net -> https://docutils.sourceforge.iomilde2022-01-2032-85/+85
| | | | | | Patch by Adam Turner. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8956 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* More changes to https://sourceforge.netmilde2022-01-207-12/+12
| | | | | | Patch by Adam Turner git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8955 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Change http://docutils.sf.net -> https://docutils.sourceforge.iomilde2022-01-2013-31/+31
| | | | | | Patch by Adam Turner. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8954 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update PEP links.milde2022-01-201-12/+9
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8953 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Add/update link to time.strftime().milde2022-01-202-4/+5
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8952 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Mark the "Backwards Compatibility Policy" as stub.milde2022-01-141-6/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8951 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Document incompatibility with "pytest" and "nosetest". Update.milde2022-01-121-2/+13
| | | | | | | | | Triggered by [feature-request:#81]. Use PEP 3102 syntax instead of reading/deleting "**kwargs" items for "required keyword arguments". git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8945 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/docutils@8942 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix sphinx adressgrubert2022-01-091-1/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8938 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Suggest de-coupling switch of version control system and host.milde2022-01-071-4/+9
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8936 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Remove lingering references to Python 2.milde2022-01-065-32/+6
| | | | | | Based on Patch 1/6 by Adam Turner (patches #188). git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8934 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Front-end documentation update and small fix.milde2022-01-052-31/+81
| | | | | | | | | Revise/fix front-end tool documentation. Add support for -h and --help options to rst2odt_prepstyles.py in order to unify behaviour. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8932 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small revision of the documentation update.milde2022-01-041-16/+15
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8930 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update.milde2022-01-043-83/+113
| | | | | | | | | | | | | | | | | | * 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/docutils@8929 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Docutils 0.19 requires Python 3.7 or later.milde2022-01-032-12/+13
| | | | | | | | | Update documentation and setup. Removal of special-casing and 2.7 compatibility hacks following soon. Specify versions in deprecation/removal announcements. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8924 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Document "myst" parser alias.milde2022-01-031-3/+9
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8923 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Avoid mutables as function argument defaults.milde2021-12-291-8/+15
| | | | | | | | | | | | | | | | | | | | | | | Mutable default values for functions are considered an anti-pattern (cf. bug #430 and https://docs.python-guide.org/writing/gotchas/#mutable-default-arguments). Mutable default values (empty lists and dictionaries) were used in the "interpreted role function" API: Interpreted role functions must accept (optional) "options" and "content" arguments and must not modify passed values. OTOH, the actual default value is irrelevant for the API, so there is no need to use mutable defaults in the specification. As a precaution and example for robust coding, mutable defaults are replaced with None in the function definitions. The documentation is updated to the current implementation (including changes in [r8254] to apply feature request #63). Fixes bug #430. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8919 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* docutils-cli.py: allow drop-in components for reader and parser.milde2021-12-231-3/+11
| | | | | | | | | Now also reader and parser may be 3rd party modules: specify the import name of the module containing the parser. Fix help output. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@8915 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
View Lorry Controller Status