Commit graph

365 commits

Author SHA1 Message Date
jiaosenvip
0379ab83a9
Fix markup.rst
Fix a minor problem in the document.

There is an extra closing bracket in the document
2023-07-29 03:14:11 +08:00
Aaron Lichtman
8e008c6d99
Update tables.rst 2023-06-21 07:00:44 -07:00
Eren Güven
97a7addc7f
add missing import to doc example 2023-01-25 21:42:10 +01:00
Jakub Wilk
e94d98df87 Fix typos 2023-01-23 19:17:03 +01:00
Dave Pearson
ef5dbf4828
Link format string in docs to Python string formatting mini-language
See #2584.
2023-01-18 14:11:33 +00:00
Will McGugan
80188f22a0 doc 2023-01-13 22:17:04 +00:00
Will McGugan
50d7df770c docs on highlighters 2023-01-13 22:14:47 +00:00
Kyan
c76366873e
add a missing quote to progress.rst 2022-11-18 20:55:58 +08:00
Will McGugan
4001aa9179
Merge pull request #2601 from davep/2559/console
Docs review of Console
2022-10-20 14:42:55 +01:00
Dave Pearson
e27258dd10
stop -> stops 2022-10-20 10:26:42 +01:00
Dave Pearson
74c5d2d6d0
Swap to "an out method" rather than "a out method" 2022-10-20 10:23:30 +01:00
Dave Pearson
293b32ce20
methods -> method 2022-10-20 10:21:44 +01:00
Dave Pearson
b25c4d6d94
Update the minimum-supported Python mentioned in the intro 2022-10-20 09:42:58 +01:00
Dave Pearson
d856be8e1c
OSX -> macOS 2022-10-20 09:41:44 +01:00
Will McGugan
84e628655a edit 2022-10-04 10:57:25 +01:00
Will McGugan
3006b2788a italics 2022-10-04 10:54:55 +01:00
Will McGugan
07e3793784 env var docs 2022-10-04 10:33:00 +01:00
Will McGugan
0bdbe550c4 quote extras 2022-09-23 16:10:33 +01:00
Will McGugan
36fa43da75 sections docs and test 2022-09-23 15:21:28 +01:00
Will McGugan
c6001e5226 added line about end_section 2022-09-23 15:10:19 +01:00
Will McGugan
f0cbc468ca
Merge branch 'master' into tuple-rich-repr-positional 2022-09-19 10:57:41 +01:00
Abdur-Rahmaan Janhangeer
c0aad1315c docs: rm copyright year 2022-09-01 15:00:36 +04:00
Abdur-Rahmaan Janhangeer
f019a373a6
docs: update copyright yea 2022-09-01 14:34:29 +04:00
Will McGugan
3fbf53acf0 box docs 2022-08-02 16:33:14 +01:00
Will McGugan
b1368b61a4
Merge pull request #2301 from tomers/iso8601-highlighter
Add Iso8601Highlighter
2022-07-11 11:46:37 +01:00
Will McGugan
65c138088a
Merge pull request #2356 from tonybaloney/patch-1
Add Github flavoured markdown box type
2022-07-11 11:43:31 +01:00
Denis Kataev
e5cb569e06
Render code as code in progress docs 2022-07-07 19:37:49 +04:00
Saul Shanabrook
833c912b41
Add support for tuples as positional arguments in rich repr
Currently, it isn't possible to use tuples as positional arguments from `__rich_repr__`, because they are special cased to support adding a key and a default value.

This adds support for them, by allowing `None` as a key.
2022-07-05 09:44:49 -04:00
Sebastián Ramírez
743f65aecc
✏ Fix micro typo "in to" to "into" 2022-07-04 11:28:33 +02:00
Anthony Shaw
2e0af2d572
Update RST 2022-06-28 09:00:44 +10:00
Tomer Shalev
8443505e21
Merge branch 'master' into iso8601-highlighter 2022-06-14 15:03:00 +03:00
Tomer Shalev
2707a73435 Add Iso8601Highlighter
Add ability to highlight date and time strings according to ISO8601 [1]

[1] https://en.wikipedia.org/wiki/ISO_8601
2022-06-14 15:02:35 +03:00
Antony Milne
29294b82d6 Add to docs 2022-06-09 23:13:31 +01:00
Darren Burns
df775dabb5 Turn "basic usage" progress example into a runnable example 2022-06-07 10:00:45 +01:00
Will McGugan
ced921b94e docs 2022-05-02 18:06:50 +01:00
Will McGugan
11f3122939 docs 2022-05-02 18:03:05 +01:00
Will McGugan
b5f0b743a7 update progress docs 2022-04-21 09:39:46 +01:00
Will McGugan
b6a83c2dce docs update 2022-04-21 09:24:15 +01:00
Olivier Philippon
052b157858 [progress] The total we pass to a Progress renderable can now be None 2022-04-13 11:02:28 +01:00
Olivier Philippon
303e9b5563 Bump minimum Python version to 3.6.3 (from 3.6.1)
The `OrderedDict[CacheKey, CacheValue]` code we use in the LRUCache class doesn't work with Python versions `3.6.1` and `3.6.2`, unfortunately
2022-04-04 16:24:29 +01:00
Will McGugan
489fafc63e
Merge pull request #2141 from Textualize/progress-docs
Progress docs
2022-04-03 14:48:15 +01:00
Will McGugan
6b9adfa9c2 docs 2022-04-02 14:22:22 +01:00
Will McGugan
8745ee5a11 progress docs 2022-04-01 14:49:02 +01:00
Will McGugan
56227ab383 docs for new progress feature 2022-04-01 14:17:21 +01:00
Darren Burns
7a870e4a4b
Merge branch 'master' into progress-reader 2022-03-30 13:42:58 +01:00
Martin Larralde
54d660def1 Update example for wrap_file in rich.progress API documentation 2022-03-30 13:26:37 +02:00
Darren Burns
9f43cccfce
Exporting console content to SVG (#2101)
* Add skeleton export_svg and save_svg methods to Console

* Exporting SVG

* SVG export - Writing HTML foreign object into naively calculated SVG rect background

* Exporting as foreign object SVG

* Working with drop-shadow

* Update terminal output style to include tab and background/border

* Add more terminal themes, support dim, reverse in SVG output

* Fix some HTML export tests

* Allow for templating of SVG output

* Fix mypy issue involving shadowed variable in SVG export

* Remove unused code from main block in console.py

* Remove unused record=True in __main__.py Console init

* Small tidy ups in console.py SVG export

* Add test for exporting to SVG

* Add tests for export SVG and save SVG

* Update docs with info on SVG exports

* Add support for blink and blink2 to SVG export, use Fira Code webfont fallback

* Update tests for SVG exporting

* Add more information to docs about SVG exporting

* Update SVG exporting tests

* Explain how to use different terminal theme in SVG export docs

* Remove some development testing code

* Remove some more testing code

* Improve docs, fix typo

* Fixing a typo

* Add note to changelog about SVG export functionality

* Use CSS styling instead of inline styles on SVG export

* Fix issues noted in code review, fix reverse style

* Update SVG used in Rich docs
2022-03-29 17:34:14 +01:00
Martin Larralde
1320046537 Split Progress.read into Progress.open and Progress.wrap_file methods 2022-03-13 18:36:47 +01:00
Martin Larralde
f3f1bca230 Reformat rich.progress and document Progress.read in progress.rst 2022-03-13 12:54:40 +01:00
Will McGugan
c1b43f0f18 better typehints in docs 2022-03-11 16:08:49 +00:00