Commit Graph

4775 Commits

Author SHA1 Message Date
Rodrigo Girão Serrão
bd719e057f Remove MessagePump.emit .emit_no_wait. 2023-02-08 10:39:53 +00:00
Will McGugan
1fd773f6ef Merge pull request #1737 from Textualize/typing-updates
typing fixes
2023-02-08 10:33:42 +00:00
Will McGugan
29875a66fc into [skip ci] 2023-02-08 10:31:35 +00:00
Will McGugan
aabc1cc898 fix typo [skip ci] 2023-02-08 10:20:47 +00:00
Dave Pearson
5e172dd635 Fully exclude the blog files from the offline docs build
The blog files were still getting included and packages, just not linked to
from the resulting "site". This meant that the final tarball was much bigger
than it needed to be, due to animated gifs and movs an the like.

This brings the tarball down from around 27M to 6.4M.
2023-02-08 10:02:02 +00:00
Dave Pearson
35be18f0e6 Explain the elaborate include path for docs in pyproject.toml
While it's still fresh in my mind as to why I wrote it like this, comment to
the effect so I'm not surprised by it in the future, or so someone else
reading it can know what the thinking was here.
2023-02-08 10:00:48 +00:00
Dave Pearson
fbdbd8928d Always poetry run commands that need a venv
It's a `Makefile` so it's handy to not have to think about if you need to be
within a poetry venv when running `make`. This commit adds a `poetry run`
before any command that needs the venv. This means that people who aren't in
a venv can just `make something` and it'll "just work", and the same is true
for those who are in a venv.
2023-02-08 09:46:47 +00:00
Dave Pearson
93f449366f Modify blog/rss plugin config to make search work again
Inheriting config for mkdocs requires that you use key/value pairs for the
plugins not a list of objects.
2023-02-08 08:41:16 +00:00
Dave Pearson
fb5346c894 Don't show the repository stats in offline mode
They require a connection, which isn't very offline...
2023-02-08 08:40:47 +00:00
Dave Pearson
9500fa925a Add a Makefile target that cleans everything cleanable 2023-02-08 08:26:34 +00:00
Dave Pearson
4055373725 Add a Makefile target for cleaning up the offline docs
Sometimes I want to be able to test from a fresh start, so this will be helpful.
2023-02-08 08:24:50 +00:00
Dave Pearson
e9fab41377 Relock
Updating mkdocs insiders' on my personal machine so I can test building docs
there and it wanted to relock again.
2023-02-08 08:24:08 +00:00
Will McGugan
a93ec81a2a extra space removed 2023-02-07 19:51:42 +00:00
Will McGugan
71b91521fc more trailing commas 2023-02-07 18:29:38 +00:00
Will McGugan
777a205bca trailing commans 2023-02-07 18:28:05 +00:00
Will McGugan
0a4d1c919d updated widgets docs 2023-02-07 18:10:01 +00:00
Rodrigo Girão Serrão
d3e66721e9 Change emit to post to self. 2023-02-07 17:59:57 +00:00
Dave Pearson
fcd84c564c Add a build command that also builds offline docs
Also include them in the source tarball.
2023-02-07 16:46:34 +00:00
Will McGugan
484676c092 comment 2023-02-07 16:01:24 +00:00
Will McGugan
6d722fd291 Fix vkey 2023-02-07 15:55:57 +00:00
Will McGugan
6888120901 update msgpack types 2023-02-07 15:18:18 +00:00
Will McGugan
77b07042c0 typing fixes 2023-02-07 15:14:47 +00:00
Dave Pearson
45af25a248 Use the privacy plugin when building the offline docs
This has the effect of bundling up a bunch of files that would otherwise be
pulled in from the net on the client side. As well as enhancing the viewer's
privacy, it also means that we increase someone's ability to view
documentation locally without the need for any sort of working net
connection.
2023-02-07 13:25:39 +00:00
Dave Pearson
f2f33233d9 Upgrade mkdocs-material 2023-02-07 13:25:12 +00:00
Will McGugan
a6d7747f28 fix 5x5 2023-02-07 12:10:02 +00:00
Will McGugan
78c1059726 Merge pull request #1730 from Textualize/typing-update
Typing update
2023-02-07 12:08:43 +00:00
Will McGugan
f2d96e6e62 or None 2023-02-07 12:01:18 +00:00
Will McGugan
7e7367f8f6 simplify typing 2023-02-07 11:58:55 +00:00
Will McGugan
ad2f3697af fix imports 2023-02-07 11:29:24 +00:00
Will McGugan
6c4adea608 update Mypy 2023-02-07 11:25:36 +00:00
Will McGugan
84edd34fa6 typing extensions import 2023-02-07 10:56:04 +00:00
Will McGugan
38140c564b imports 2023-02-07 10:54:29 +00:00
Dave Pearson
19bde351a6 Get search appearing again
Search had gone from everywhere. Turns out that there's a very particular
way you have to specify the plugins in YAML if you want to use INHERIT.
2023-02-07 10:52:46 +00:00
Will McGugan
638d123cf2 poetry lock 2023-02-07 10:52:11 +00:00
Will McGugan
5930ebf82e remove _typing.py 2023-02-07 10:46:28 +00:00
Dave Pearson
496667abed Tidy up the Makefile a bit
This removes the duplication of the screen cache cleaning, and also turns it
into a target so you can do it yourself from the command line if needed. It
also marks all the phony targets as such (that is, targets that aren't
actually items in the filesystem).
2023-02-07 10:29:20 +00:00
Dave Pearson
a8aaa7ad82 Experiment with the mkdocs offline plugin
In doing so, don't emphasise online docs over offline, but instead make this
about an online/offline split and both are as important as each other.
2023-02-07 10:06:05 +00:00
Will McGugan
bcf382d2ff typing of Final 2023-02-07 09:06:08 +00:00
Will McGugan
af7fb9b02a Experiment 2023-02-06 18:01:41 +00:00
Will McGugan
29ba43af01 typealias import 2023-02-06 17:49:12 +00:00
Will McGugan
069ef11df8 Experiment 2023-02-06 17:44:29 +00:00
Will McGugan
fe793b348a remove print 2023-02-06 17:38:08 +00:00
Will McGugan
f803dd8265 type alias 2023-02-06 17:22:01 +00:00
Will McGugan
48124bdc0d fix finals 2023-02-06 17:17:02 +00:00
Dave Pearson
aece00e1dc Remove the keystrokes from the dictionary example in events guide
As well as not being necessary for the example, it also had the problem of
not actually having the input in focus (there was no press of 'tab' to kick
things off) and so the other keys didn't go into the `Input` as they were
supposed to.
2023-02-06 16:06:50 +00:00
Dave Pearson
4e4353b2ce Remove the dictionary example from the front page of the docs
Sometimes, when building the docs, this would end up being a bit of an
"empty" example in that the time taken to get the result back from the API
would be so long that the output would be of the request just in progress.

So we've decided to drop this from the front page.
2023-02-06 16:04:52 +00:00
Dave Pearson
a8ded8f0a6 Move some more live-site config into the correct config file 2023-02-06 14:28:13 +00:00
Dave Pearson
e6fbe71c04 Solve the problem of local docs and directory/index.html links
See https://github.com/Textualize/textual/issues/631#issuecomment-1418960080
-- this addresses that problem pretty much perfectly.
2023-02-06 14:05:21 +00:00
Dave Pearson
9acbc0cd67 Add a method of building a local copy of the docs
This will build the docs into a directory called docs-local, sans the blog.
Note the near-total copy/paste of the `nav` due to how mydocs does
configuration inheritance; this is fine for now.
2023-02-06 13:58:44 +00:00
Dave Pearson
dcdad6230f Move the blog config out into the "live site" config 2023-02-06 13:58:15 +00:00