6 Commits

Author SHA1 Message Date
Dave Pearson
806a6663ad Remove the privacy plugin from the offline version of the docs
Yes, this does pretty much undo the "offline" part, but without this the
docs can't build if the builder doesn't have access to the insiders' edition
of mkdocs. Doing this as a first step to investigating if there's any
possible way to achieve what we want here:

- Anyone can build
- They can build offline
- They can build for maximum privacy

If not, this step at least hits the first requirement.

See #2629.
2023-05-29 07:40:30 +01: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
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
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
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
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