Will McGugan
5d6a95dec5
Command Palette tweaks and docs ( #3289 )
...
* renames to command palette and docs
* docs
* simplifyt
* note
* docstring
* Update src/textual/command.py
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com >
* Update docs/examples/guide/command_palette/command01.py
Co-authored-by: Dave Pearson <davep@davep.org >
* populate text
* screen commands
* Update docs/guide/command_palette.md
Co-authored-by: Dave Pearson <davep@davep.org >
* Update docs/guide/command_palette.md
Co-authored-by: Dave Pearson <davep@davep.org >
---------
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com >
Co-authored-by: Dave Pearson <davep@davep.org >
2023-09-13 15:03:25 +01:00
Dave Pearson
0a14bf0549
Merge pull request #3287 from davep/blog-metadata-update
...
Update the blog author metadata.
WARNING: Be sure to do an update of dependencies before serving or building docs from this point on!
2023-09-12 14:18:38 +01:00
Dave Pearson
8e315a1cd1
Update the blog author metadata
...
As per the warning if you use the latest release of mkdocs-material:
WARNING - Action required: the format of the authors file changed.
All authors must now be located under the 'authors' key.
Please adjust 'docs/blog/.authors.yml' to match:
authors:
squidfunk:
avatar: https://avatars.githubusercontent.com/u/932156
description: Creator
name: Martin Donath
Note that this is for after:
Updating mkdocs-material (8.5.9+insiders.4.26.2
/Users/davep/develop/python/mkdocs-material-insiders -> 9.2.7)
It's also worth noting that our docs should now build regardless of
insiders' edition or not now; given that the blog module is part of the
mainstream release.
2023-09-12 13:04:49 +01:00
Dave Pearson
6d1967be7a
Merge pull request #3276 from TomJGooding/docs-add-datatable-supplementary-classes
...
docs: add datatable supplementary classes
2023-09-12 12:57:32 +01:00
Will McGugan
9ca0929099
Merge branch 'main' into M-x
2023-09-11 14:49:28 +01:00
Rodrigo Girão Serrão
d39c0c3a89
Improve documentation.
2023-09-11 14:28:23 +01:00
TomJGooding
3d7f5e2c74
docs: add datatable supplementary classes
2023-09-11 13:16:07 +01:00
Rodrigo Girão Serrão
63ace0715e
Merge branch 'main' into input-blur-validation
2023-09-11 11:30:38 +01:00
Will McGugan
85970972d9
blog post ( #3248 )
...
* blog post
* bump timestamp
* words
2023-09-06 17:53:31 +01:00
Dave Pearson
5a272c539d
Bump predicted command palette escape to the wild to 0.37.0
2023-09-06 14:48:06 +01:00
Dave Pearson
85a3af320a
Merge branch 'main' into M-x
2023-09-06 14:46:33 +01:00
TomJGooding
06b6426750
feat: add rule widget ( #3209 )
...
* feat: add rule widget
* add star to init
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com >
* remove unnecessary validations
* update rule styles
* add tests for invalid rules
* add minimum heights and widths
* tidy up examples
* remove old example
* move examples styling to tcss
* modify examples to fit docs screenshots
* add docs first draft
* add snapshot tests
* add rule to widget gallery
* make non-widget rule classes available
* tentatively update changelog
---------
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com >
Co-authored-by: Will McGugan <willmcgugan@gmail.com >
2023-09-04 17:57:10 +01:00
Will McGugan
cbed79c7eb
Modes docs ( #3233 )
...
* Modes docs
* Added current mode
* fix docstring
* diagrams
* Update docs/guide/screens.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com >
* Update docs/guide/screens.md
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com >
* words
---------
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com >
2023-09-04 17:40:40 +01:00
Dave Pearson
1fcf259e6d
Merge branch 'main' into M-x
2023-09-04 16:40:32 +01:00
Dave Pearson
6d4fcaa4c6
Merge pull request #3232 from davep/see-also-focus-blur
...
Add see-also entries to the various blur/focus messages
2023-09-04 15:46:48 +01:00
Dave Pearson
9f83145d70
Boring sort rather than exciting sort
...
Co-authored-by: Rodrigo Girão Serrão <5621605+rodrigogiraoserrao@users.noreply.github.com >
2023-09-04 15:40:33 +01:00
Dave Pearson
cd1b29fb2b
Add see-also entries to the various blur/focus messages
...
This question crops up from time to time, often with people looking for
"focus" or "blur" and wondering why they don't bubble and so then wondering
how they can catch such events in ancestors in the DOM.
The Descendant prefix isn't obvious (I always forget what it is and need to
go hunting), so having the focus and blur events link to the descendant
events should help make them easier to discover.
2023-09-04 15:33:44 +01:00
Will McGugan
c63d8e05fa
return code docs ( #3231 )
...
* return code docs
* words
* words
* Update docs/guide/app.md
Co-authored-by: Dave Pearson <davep@davep.org >
* Update docs/guide/app.md
Co-authored-by: Dave Pearson <davep@davep.org >
---------
Co-authored-by: Dave Pearson <davep@davep.org >
2023-09-04 14:03:25 +01:00
Dave Pearson
32ea9584a5
Add a note about retaining the default Textual command sources
2023-08-31 11:27:45 +01:00
Dave Pearson
70ee49b140
Add a wee note about what happens to unhandled exceptions
2023-08-31 11:24:07 +01:00
Dave Pearson
25a0d3b7ab
Tentatively mark the command palette as going into v0.36.0
2023-08-30 15:38:17 +01:00
Dave Pearson
110ea786ae
Merge branch 'main' into M-x
2023-08-30 13:17:04 +01:00
Rodrigo Girão Serrão
4826e436a8
Complete docs about customising validation.
2023-08-28 15:59:03 +01:00
Dave Pearson
e6b9a264a1
Rename search_for to search
...
As per this request:
https://github.com/Textualize/textual/pull/3058#discussion_r1307135816
2023-08-28 11:05:39 +01:00
Dave Pearson
ab0126f672
Link the centring FAQ to the HOWTO
...
Keeping it as a FAQ makes sense, as it means that FAQtory will be able to
point to it, but now that we have the HOWTO, and it's more comprehensive, it
makes sense to direct the reader in that direction if they want something
more involved.
2023-08-28 08:39:57 +01:00
Dave Pearson
1b1e26cd16
Merge branch 'main' into M-x
2023-08-28 08:30:41 +01:00
Will McGugan
59646ff21a
faq tweak
2023-08-26 10:57:44 +01:00
Will McGugan
d89871b045
update docs for tcss ( #3179 )
...
* update docs for tcss
* letter
2023-08-26 10:49:18 +01:00
Dave Pearson
888557747c
Reinstate the FAQtory-friendly links in the FAQ ( #3142 )
2023-08-26 08:35:41 +01:00
Dave Pearson
c9d3e2d8b7
Merge branch 'main' into M-x
2023-08-23 14:22:28 +01:00
Rodrigo Girão Serrão
5ee0ebfef4
Rename CSS files to TCSS.
...
Related issue: #3137 .
2023-08-22 13:21:17 +01:00
Dave Pearson
ec860fc274
Give a quick example of declaring a COMMAND_SOURCE
2023-08-22 10:57:03 +01:00
Dave Pearson
bb90b58312
Drop the run helper method in the command source
2023-08-22 10:48:02 +01:00
Dave Pearson
64354a35fd
Merge branch 'main' into M-x
2023-08-22 08:29:50 +01:00
Dave Pearson
af4423166b
Rename hunt_for to search_for
...
Sounds a lot less dramatic but... okay, fair enough.
2023-08-21 19:37:24 +01:00
Dave Pearson
bb20cdc2bf
Move the Textual FAQ into the main docs
...
See #3068 .
2023-08-21 14:41:07 +01:00
Dave Pearson
30bd82e25e
Link the Header docs to App.title and App.sub_title
...
Closes #3103 .
2023-08-21 12:57:16 +01:00
Dave Pearson
fa2c875e04
General language tidying
...
Fixes typos and awkward wording.
2023-08-21 09:17:09 +01:00
Dave Pearson
c616e50d55
Start fleshing out the main command palette documentation
2023-08-17 16:20:16 +01:00
Dave Pearson
c1aba61349
Add the fuzzy matcher to the docs
...
While it isn't designed to be used directly, it is something a developer
will be exposed to via the command source for the command palette, so it
should appear in the docs so it can be linked to.
2023-08-17 15:33:31 +01:00
Dave Pearson
5fea151a7f
Add the system command sources into the docs
2023-08-17 14:18:54 +01:00
Dave Pearson
7fc3604dfa
Pull the command palette into the API docs
2023-08-17 11:21:29 +01:00
Will McGugan
dda2cb2be2
auto grid docs and test
2023-08-17 10:46:57 +01:00
Rodrigo Girão Serrão
fbe1c416a4
Hide some members from the public docs. ( #3080 )
...
* Hide some members from the public docs.
See relevant issue: #3076 .
Some methods need to be implemented to make the widget work but the user doesn't really care about them. For that matter, we can hide them from the public documentation.
* Use private handler to hide from docs.
Related comments: https://github.com/Textualize/textual/pull/3080#issuecomment-1671129733
2023-08-15 16:53:14 +01:00
Will McGugan
a0be460921
border classvars ( #3097 )
...
* border classvars
* changelog
* copy
* remove whitespace
* copy
2023-08-15 10:34:24 +01:00
Rodrigo Girão Serrão
eccf746f5a
Merge pull request #3054 from dmunozv04/main
...
Fix links in documentation
2023-08-10 08:58:49 +01:00
David
63dff34af9
Update layer.md
...
Fix the link I managed to break
2023-08-09 19:57:35 +02:00
Will McGugan
49281b3f27
Digits ( #3073 )
...
* Digits
* digits widget
* update requires str
* digits docs
* simplify
* tweak docs
* snapshot test
* change name
* simplify
* docs
* Update _digits.py superfluous import
* Update _digits.py docstring
* address review
* formatting
* Update tests/snapshot_tests/snapshot_apps/digits.py
Co-authored-by: Dave Pearson <davep@davep.org >
---------
Co-authored-by: Dave Pearson <davep@davep.org >
2023-08-09 10:25:17 +01:00
Will McGugan
af315a3af7
Merge branch 'main' into 2905-send-mouse-move-events-to-screen
2023-08-08 16:27:13 +01:00
dmunozv04
41fe544a1f
Fix broken link
2023-08-08 13:38:47 +02:00