summaryrefslogtreecommitdiff
path: root/docutils/docs/howto
Commit message (Collapse)AuthorAgeFilesLines
* Improve internationalisation documentationmilde2022-07-291-10/+24
| | | | | | | | | 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
* Minimalistic menu bar for documentation pages.milde2022-04-026-1/+12
| | | | 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-1/+67
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9050 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
* Update URLs in the docs.milde2022-01-211-4/+4
| | | | | | | | 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-203-3/+3
| | | | | | Patch by Adam Turner. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8956 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Change http://docutils.sf.net -> https://docutils.sourceforge.iomilde2022-01-201-1/+1
| | | | | | Patch by Adam Turner. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8954 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@8919 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix spellingmilde2021-10-222-2/+2
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8860 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix spelling errors.milde2021-10-211-2/+2
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8859 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update.milde2021-03-262-10/+15
| | | | | | | | Fix or remove broken links. Adapt to changes in recent versions. Adapt to state of the art in HTML and web browsers. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8644 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update. Warn about file overwriting.milde2021-03-201-23/+44
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8640 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small documentation updates and fixes.milde2021-03-051-1/+1
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8631 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Limit length of input lines and substitution expansion.milde2020-09-141-0/+4
| | | | | | | | | | | | | | | | | | Mitigate the danger of DoS attacs using specially crafted rST input (cf. bug #381). The default value of 10 000 characters should suffice for legitimate use cases (e.g. long paragraphs in auto-wrapping editors or extensive creative use of substitutions). Applications processing untrusted rST might wish to lower this limitation (together with other safety measures described in docs/howto/security.txt). Unsupervised processing of untrusted rST input should always be safeguarded with limits on processing time and memory use. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8565 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* small documentation updatemilde2020-09-011-19/+16
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@8551 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Clean up LanguageImporter. Update documentation.milde2020-01-261-20/+2
| | | | | | | | | * Fix caching. * Report missing/incomplete modules and language-variant substitutions (info). * Move documentation from instance to class definition. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@8467 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Document possible heavy ressource use when parsing untrusted input.milde2019-12-121-1/+12
| | | | | | See bug #381. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@8435 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* HTML writers: Outsourcing of common code to _html_base.py.milde2016-11-291-1/+1
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7977 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update.milde2015-03-211-22/+25
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7852 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix references of CVS to code HEADgrubert2014-07-071-3/+3
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7769 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix link to bug trackergrubert2014-07-071-2/+2
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7768 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* change to :Contact: docutils-develop@lists.sourceforge.netgrubert2012-01-035-6/+5
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7302 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update and fix link. PEP 263 now widely supported.milde2011-10-151-10/+8
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7181 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* reStructuredText "code" role and directivemilde2011-09-021-1/+1
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7119 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Handle language codes according to BCP 47 milde2010-09-171-7/+14
| | | | | | | | | | | | | (Best Current Praxis: Tags for Identifying Languages). Normalize language tags: downcase, - to _, optional subtags. E.g. Given "de-AT-1901", look for language modules "de_at_1901", "de_at", "de_1901", and "de" TODO: warn (instead of fail), if no module found. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@6423 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* fix in code example, reported by Edward Z. Yanggoodger2009-11-201-1/+1
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@6199 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* use full termgoodger2008-12-101-2/+2
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5818 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* html-stylesheets.txt: made links relative, added link to config.txt.milde2008-12-101-4/+8
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5817 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* html-stylesheets.txt: document multiple stylesheet optionmilde2008-12-091-6/+18
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5815 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* adjusted name and email addresswiemann2007-05-312-4/+4
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5174 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added Version Applicability sectiongoodger2006-11-121-0/+10
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4808 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* updatedgoodger2006-11-121-1/+1
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4806 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added "Deploying Docutils Securely"goodger2006-11-121-0/+158
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4803 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* removed CVS referencegoodger2006-10-091-2/+2
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4765 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added link to admonition directive documentationwiemann2006-08-071-3/+5
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4671 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* merged directives branch to trunk (r4375:4666);wiemann2006-07-121-291/+321
| | | | | | | | assert that block quote directives have content; improved test for block quote directives (test_block_quotes); deleted test_epigraphs_etc (replaced by test_block_quotes) git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4667 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* typogoodger2006-06-281-1/+1
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4642 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* use $Id$ instead of $Date$ and $Revision$;wiemann2006-05-211-1/+1
| | | | | | | | collapsed Author and Contact fields; use canonical email addresses for David and Felix; (I have reviewed the diff) git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4564 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Converted ``docutils/writers/support/`` into individual writer packages; ↵goodger2005-12-091-1/+1
| | | | | | updated docs & refs. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4163 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* updated for new stylesheet location; thanks to Michael Foord for pointing ↵goodger2005-09-301-16/+19
| | | | | | this out git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3913 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* minor improvementswiemann2005-08-261-2/+2
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3838 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added HTML (CSS) stylesheet howtowiemann2005-08-261-0/+73
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3836 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* fixed linkswiemann2005-05-281-1/+1
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3398 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* updated rst-roles howto to match new "classes" list attributewiemann2005-05-271-4/+8
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3394 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Added "uri" directive option conversion function. Added docstrings & ↵goodger2005-03-151-2/+25
| | | | | | documentation. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3045 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Allowed whitespace in paths and URLs (targets; "image", "figure", & ↵goodger2005-03-051-10/+2
| | | | | | "include" directive args; ":file:" & ":url:" directive options). git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3018 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added section about submitting translationswiemann2004-09-131-2/+11
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2610 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* updatedgoodger2004-06-051-7/+9
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2219 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* updatedgoodger2004-06-051-9/+25
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2218 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* updatedwiemann2004-06-032-2/+2
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2205 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
View Lorry Controller Status