Commit Graph

23 Commits

Author SHA1 Message Date
Dave Pearson
1a42b5024d Add a Makefile target for building the FAQ
I always have to double-check. Now I can just "make faq".

Or at least I have somewhere else to double-check if I forget the Makefile
target.
2023-03-30 11:26:48 +01:00
Rodrigo Girão Serrão
e15805b93b Fix #1540. (#2097) 2023-03-23 09:38:50 +00:00
Dave Pearson
27ebdc4ec3 Add a Makefile target for installing pre-commit hooks
Any time I cause my venv to be rebuilt, I need to remember to do this, and I
always have to search my shell history to remind myself what the command is.
That feels like it deserves to go into the Makefile.
2023-03-01 12:44:51 +00:00
Dave Pearson
9dc0a4b57d Add setup and update targets to the Makefile
Simply adds `make setup` as a shorthand for running the poetry command that
does the initial install for local development, and also `make update` to do
a package update. Simply aimed as handy extras for development.
2023-02-09 16:18:34 +00:00
Dave Pearson
5376b015f5 Bring the docs deployment target into the new approach
This one's a little vague right now, and I'm not sure how best to test this.
Looking at the mkdocs documentation it isn't clear to me that you *can*
provide the config file to the gh-build command, but there's example command
lines in the docs showing that you can.

Need to see if there's a safe way to test this out -- the last thing I want
to do is nuke our website.
2023-02-08 14:58:06 +00:00
Dave Pearson
a295c5f968 Work towards having a single nav file
The idea here is that there is a single file for the nav for all the docs,
both online and offline. The nav will be the full online nav in all its blog
glory, and then the build system will strip out the nav items relating to
the blog when building the offline version.

There's a wrinkle or two still in here; the main one being that when doing a
docs-serve, it seems that the cleaning up of the online nav doesn't happen
when you Ctrl-C out of the server. I'm not 100% sure of the cause of
this (there could be a couple of different reasons).

For now... I'm ensuring that the online/offline nav files are excluded from
git. It would be nice to find out how best to always ensure that the online
nav file is removed so nobody attempting to update the docs gets confused
about what to edit.
2023-02-08 14:36:56 +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
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
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
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
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
Will McGugan
a46eda2fa0 Added blog 2022-11-06 15:41:12 +00:00
Darren Burns
d2f8ad5257 Add Makefile target for snapshot update 2022-09-20 15:46:08 +01:00
Will McGugan
b2db7a63ab deploy command 2022-09-06 15:32:02 +01:00
darrenburns
a166d84eef Register callbacks at message pump level, invoke them after refresh (#607)
* Register callbacks at message pump level, invoke them after refresh

* Fix a typo

* Code review feedback actions

* call_later callbacks invoked after refresh or on idle

* Fix space key in text input

* Make Widget.on_idle synchronous

* Fix call_later

* Rename PostScreenUpdate to InvokeCallbacks, and only fire if callbacks exist

* Update type hints for InvokeLater callbacks

* Update type signature of call_later callbacks, extract typevar
2022-08-05 13:47:47 +01:00
Will McGugan
57dec90cc4 fix for simple app case 2022-06-01 18:00:25 +01:00
Darren Burns
fd47ef491b Separate parsing of scalar, number, duration 2022-01-19 14:56:03 +00:00
Will McGugan
752609962f type fixes 2021-07-17 09:48:04 +01:00
Will McGugan
bc7ce4b969 black 2021-07-17 09:13:46 +01:00
Will McGugan
a7d2d2be70 added black to makefile 2021-07-05 20:43:37 +01:00
Will McGugan
e52af23f0f workflow 2021-07-05 20:37:54 +01:00