summaryrefslogtreecommitdiff
path: root/docutils/docs/dev
Commit message (Collapse)AuthorAgeFilesLines
* 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
* 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
* 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
* 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-011-42/+37
| | | | | | | | | | 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
* Small documentation fixes and updates.milde2022-11-281-5/+5
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9281 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
* Documentation updatemilde2022-11-181-27/+32
| | | | | | | | | | | | | | | | 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
* Move ``quicktest`` to ``tools/dev``aa-turner2022-11-022-2/+1
| | | | | | | | | | 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
* Remove dead link.milde2022-06-221-5/+5
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@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@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@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@9083 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update.milde2022-06-201-2/+2
| | | | | | | | 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
* 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@9076 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Command line "entry point" to the docutils package. Part 2/2.milde2022-05-301-40/+1
| | | | | | | | | | | | | | 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-0/+17
| | | | | | | | | | 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
* Minimalistic menu bar for documentation pages.milde2022-04-0213-3/+28
| | | | 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/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9050 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update PEP URLs.milde2022-03-132-6/+6
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@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@9043 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation fixes/clarifications.milde2022-03-031-79/+82
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9014 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update the Runtime Settings API documentation.milde2022-02-031-0/+303
| | | | | | | | | 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@8996 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix trailing whitespace (non-Python files).milde2022-01-294-9/+9
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8995 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update URLs in the docs.milde2022-01-219-106/+94
| | | | | | | | 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-2011-21/+21
| | | | | | 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-203-5/+5
| | | | | | 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-13/+13
| | | | | | Patch by Adam Turner. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8954 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@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@8945 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix sphinx adressgrubert2022-01-091-1/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@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@8936 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Remove lingering references to Python 2.milde2022-01-063-26/+5
| | | | | | 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
* Small revision of the documentation update.milde2022-01-041-16/+15
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8930 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update.milde2022-01-042-80/+109
| | | | | | | | | | | | | | | | | | * 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
* Docutils 0.19 requires Python 3.7 or later.milde2022-01-031-8/+8
| | | | | | | | | 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@8924 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small documentation updates and fixes.milde2021-12-231-0/+2
| | | | | | | 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
* Small update of the TODO document.milde2021-11-271-14/+16
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8908 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Draft proposal for a Docutils backwards compatibility policy.milde2021-11-271-3/+46
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8907 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Revise/Update the `Running the Test Suite` documentation.milde2021-11-271-44/+40
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8906 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* rephrasegrubert2021-11-231-1/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8905 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* regenerate wheel after tagging sourcegrubert2021-11-231-1/+11
| | | | | | | clear cache git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8902 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Clean up the Policies document.milde2021-11-191-94/+13
| | | | | | | | | (Re)move additons by Günter Milde that belong somewhere else: * How to get a new feature into Docutils -> FAQ. * Rationale/background info for choosing the BSD 2-Clause license. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8898 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Repository documentation: make clear that Github mirrors are from 3rd party.milde2021-11-051-34/+37
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8876 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update/additions.milde2021-11-011-16/+33
| | | | | | | Remove implemented TODO item. Add entry for rst2man.py tool. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8874 929543f6-e4f2-0310-98a6-ba3bd3dd1d04