Commit Graph

849 Commits

Author SHA1 Message Date
Rodrigo Girão Serrão
bc729033c8 Merge branch 'main' into doc-improvements 2023-01-26 13:55:34 +00:00
Rodrigo Girão Serrão
b37517c400 Add all messages to widget references. 2023-01-26 11:53:51 +00:00
Will McGugan
211280e0be Fixed wording of tree node docs 2023-01-26 12:37:57 +01:00
Will McGugan
d01c8a7e07 more superfluous words 2023-01-26 12:34:10 +01:00
Will McGugan
56ef37637b superfluous words 2023-01-26 12:31:45 +01:00
Will McGugan
15f116d160 moved link 2023-01-26 12:25:43 +01:00
Will McGugan
dc5041f1e1 update to intro page, fix for API docs 2023-01-26 12:21:49 +01:00
Rodrigo Girão Serrão
210e39488f Add template for widget reference. 2023-01-26 10:56:32 +00:00
Rodrigo Girão Serrão
ef779d71dd Add bindings and component classes to reference pages. 2023-01-25 15:19:16 +00:00
Rodrigo Girão Serrão
fcba6ecaad Omit default values for attributes.
We copy the mkdocstrings template for attributes so that we can exclude the (default) value for attributes (and class variables) from the documentation as that is generally useless.
2023-01-25 11:41:05 +00:00
Dave Pearson
faac89fd8d Remove mention of ChildrenUpdated from the ListView docs
As pointed out in #1649, a `ChildrenUpdated` message is documented but it
doesn't exist in the code. It looks like it got added during development,
then removed after it was realised it wasn't needed, but presumably it got
left in the docs:

  https://github.com/Textualize/textual/pull/1143#discussion_r1030409026
2023-01-24 07:47:18 +00:00
Will McGugan
c214ca3697 Merge pull request #1598 from davep/pcent-text-update
Seek to improve the explanation of what a percentage does
2023-01-18 02:14:58 -08:00
Dave Pearson
05b3ab6c78 Refine the explanation of percentage
Co-authored-by: Will McGugan <willmcgugan@gmail.com>
2023-01-18 10:05:40 +00:00
Will McGugan
5fad4ad36c Merge branch 'main' into datatable-events 2023-01-18 01:46:21 -08:00
Will McGugan
c87711ca0d Merge pull request #1551 from Textualize/fix-1420
Raise clearer exception when `none` is in a space-separated list of text styles.
2023-01-17 10:05:27 -08:00
Dave Pearson
330950e6b0 Seek to improve the explanation of what a percentage does
I've seen a couple or so folk get confused about what a percentage value for
a dimension means, often seeming to think it means that percentage of
the *remaining* space within a container as opposed to a percentage of the
space in the container (note total space, not remaining space).

I'm not sure the wording here is the final form we want (there's more
mention of "dimension" here than your average Star Trek or Doctor Who
episode!), but I think it's narrowing in on it.

Making this change to place-hold the need to improve this and perhaps gather
some input to find the best final wording.
2023-01-17 16:33:30 +00:00
Darren Burns
be45db4573 Use autodoc for DataTable Messages reference 2023-01-17 13:00:01 +00:00
Darren Burns
23eb13d12d Some DataTable doc updates, rename Coord -> Coordinate and extract to module 2023-01-17 11:06:21 +00:00
Darren Burns
f327f1d2af Small datatable docs rewording 2023-01-17 10:11:19 +00:00
Darren Burns
9bc93cd683 Small datatable docs rewording 2023-01-17 10:06:39 +00:00
Darren Burns
65223be8be Merge branch 'main' of github.com:Textualize/textual into datatable-events 2023-01-16 11:00:10 +00:00
Darren Burns
2814e1f93c Documentation updates 2023-01-16 10:50:41 +00:00
Will McGugan
027635b978 merge 2023-01-12 17:45:36 +00:00
Rodrigo Girão Serrão
036c3e8651 Update documentation. 2023-01-12 14:42:04 +00:00
Will McGugan
1c4fe0c4fb added text re navigation 2023-01-10 18:18:59 +00:00
Will McGugan
e4cef274b1 tweak 2023-01-10 18:18:59 +00:00
Will McGugan
809e7c9d08 Merge pull request #1537 from Textualize/fix-docs-api
Minor doc fixes.
2023-01-10 08:15:44 -08:00
Will McGugan
43915b9415 update to introduction 2023-01-10 16:07:33 +00:00
Rodrigo Girão Serrão
e1d36e5be8 Minor doc fixes. 2023-01-10 14:45:37 +00:00
Rodrigo Girão Serrão
0f3aff6fb1 Merge pull request #1408 from Textualize/review-styles-reference
Review styles reference
2023-01-10 14:20:11 +00:00
Ofek Lev
9b779c130d Fix typo 2023-01-10 01:42:16 -05:00
Rodrigo Girão Serrão
d41471034a Fix failing tests. 2023-01-09 16:39:12 +00:00
Rodrigo Girão Serrão
130d8b8d05 Increase negative y offset. 2023-01-09 16:34:24 +00:00
Rodrigo Girão Serrão
15691b4451 Remove debugging style. 2023-01-09 16:34:06 +00:00
Rodrigo Girão Serrão
5cad93220e Merge branch 'main' into review-styles-reference 2023-01-09 16:19:24 +00:00
Rodrigo Girão Serrão
a3a452b674 Highlight rule usage in references.
[skip ci]
2023-01-09 16:14:11 +00:00
Rodrigo Girão Serrão
a1b9d4b2c5 Fix examples. 2023-01-09 16:11:45 +00:00
Rodrigo Girão Serrão
2827edcd49 Add example with all padding types. 2023-01-09 15:43:34 +00:00
Rodrigo Girão Serrão
e81779f97c Add 'See also' sections to references. 2023-01-09 15:25:47 +00:00
Rodrigo Girão Serrão
8bf211b898 Fix typo. 2023-01-09 14:14:14 +00:00
Rodrigo Girão Serrão
1300807b3a Put example outputs in first tab. 2023-01-09 13:57:04 +00:00
Rodrigo Girão Serrão
e7afcbc0b5 Add reference to 'textual borders' command. 2023-01-09 13:52:02 +00:00
Rodrigo Girão Serrão
dd6e73aa39 Add subsections for references with 2+ examples. 2023-01-09 13:50:45 +00:00
Rodrigo Girão Serrão
71b859b6e2 Add thorough example for all outlines. 2023-01-09 13:49:32 +00:00
Rodrigo Girão Serrão
da9a481f1c Remove inclusion of old css types snippets.
Supposedly, this had been done in an earlier commit for all styles. Apparently, I forgot to open styles references that were one level deeper in the directory, so the pages about grid, links, and scrollbar colors still included the css types values directly in their reference pages.
2023-01-09 11:28:47 +00:00
Rodrigo Girão Serrão
196d430582 Style all Textual CSS as 'sass'
Textual CSS is better highlighted in SASS code blocks because the SASS parser seems to be more lenient.
2023-01-09 11:20:04 +00:00
Rodrigo Girão Serrão
40cbbc31b8 Add note about viewport size.
[skip ci]
2023-01-09 10:54:04 +00:00
Rodrigo Girão Serrão
1ef20eb4ec Improve CSS type color reference.
[skip ci]
2023-01-09 10:29:47 +00:00
Dave Pearson
0a190193d7 Link to GitHub and Discord early on
For the benefit of those who aren't there yet.
2023-01-09 10:16:52 +00:00
Dave Pearson
bd9d88fa4f Fix a typo 2023-01-09 10:10:29 +00:00