David Lechner
1e6d18c915
docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build.
...
This enables warnings as errors and fixes all current errors, namely:
- reference to terms in the glossary must now be explicit (:term:)
- method overloads must not be declared as a separate method or must
use :noindex:
- 2 cases where `` should have been used instead of `
2020-06-05 21:42:17 +10:00
Jason Neal
7ef2f65114
docs/library: Add / to indicate positional-only args in library docs.
...
Removes the confusion of positional-only arguments which have defaults that
look like keyword arguments.
2020-01-12 13:44:59 +11:00
Yonatan Goldschmidt
a0d60c574a
docs/ure: Fix match.group signature to indicate index param is required.
2019-02-08 17:06:19 +11:00
Paul Sokolovsky
169b152f29
docs/ure: Fully describe supported syntax subset, add example.
2018-12-13 01:16:30 +11:00
Damien George
41226e9a18
docs/ure: Document some more supported regex operators.
2018-07-02 14:55:05 +10:00
Damien George
4727bd1db8
docs/ure: Document sub(), groups(), span(), start() and end().
2018-07-02 14:55:05 +10:00
Paul Sokolovsky
5b1b80a8db
docs/ure: Emphasize not supported features more.
...
Plus, additional descriptions/formatting.
2017-11-08 00:24:39 +02:00
Paul Sokolovsky
ad5a6f5917
docs/ure: Add flags arg to ure.compile(), mention that ure.DEBUG is optional.
2017-11-04 00:26:31 +02:00
Paul Sokolovsky
80e3f07e7f
docs/ure: Add "|" (alternative) to the list of supported operators.
2017-10-31 14:46:08 +02:00
Paul Sokolovsky
465d84b7e7
docs/library: Add CPython docs xref to each pertinent module.
...
Cross-reference text/link is implemented as RST substitution, so easy to
consistently.
2017-07-02 15:37:31 +03:00
Paul Sokolovsky
d80ecad03f
docs/ure: Elaborate doc, update markup to the latest conventions.
2017-07-02 02:01:47 +03:00
Paul Sokolovsky
9b18811951
docs/ure: Typo fix.
2016-06-07 08:53:54 +03:00
Paul Sokolovsky
3a5352b483
docs: Add skeleton docs for ure module.
2014-12-04 00:07:00 +02:00
