Commit Graph

11 Commits

Author SHA1 Message Date
Will McGugan
6c958a1140 docs update (#2239)
* docs update

* class template

* no annotations in sig
2023-04-07 18:57:56 +01:00
Dave Pearson
aad6d98aa5 More documentation tweaks (#2001)
* Change the title of some widget references to their class names

The widget reference index had a slight mixture of widget title styles, some
being their class name, others being "written English" type titles. This
settles on the titles always being the class name.

* Add a link to the ContentSwitcher to the widget gallery

No screenshot for this, on purpose. By definition this widget isn't visible,
except via other widgets that it's enclosing and handling.

* Have mkdocs watch the main nav file

* Mark the content switcher off the roadmap
2023-03-09 14:01:48 +00:00
Dave Pearson
928ab661f7 Don't watch the generated mkdocs configs (#1985)
I got a bit carried away with what to watch, and it looks like the mkdocs
watch plugin doesn't much care for watching for files that don't exist but
may.
2023-03-08 17:41:40 +00:00
Dave Pearson
e6e9d2b698 Add all the mkdocs config files to the reload-watcher
When I made the changes to documentation generation I split up the then
single mkdocs configuration file. It looks like the reloader for mkdocs
always watches its configuration file, bit *only* the one that was loaded in
the first place, not any that are inherited from.

So this change adds all of the mkdocs yml files to the watch list to ensure
that any change causes the documentation server to reload.

Most useful if you're adding new files to the navigation.
2023-03-08 08:36:22 +00:00
Dave Pearson
9fa10ecc18 Interlink the docs with the Python and Rich manuals
All through our docs there are mentions of Python types and also Rich types.
This change will make the vast majority of mentions of them into actual
links that people can follow. So now, for example, when someone sees a
method that returns a `Style`, they can click on it and see what a `Style`
actually is.
2023-03-01 15:42:38 +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
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
Dave Pearson
a8ded8f0a6 Move some more live-site config into the correct config file 2023-02-06 14:28:13 +00:00
Dave Pearson
dcdad6230f Move the blog config out into the "live site" config 2023-02-06 13:58:15 +00:00
Dave Pearson
6951ff5e60 Move almost all of the docs config into a "common" file
With #631 in mind, start by moving the vast bulk of the documentation
configuration into a "common" file, and just keep the `nav` in the main
configuration file. The thinking here is that I want two entry points -- one
for building the full docs for the Textual website, and one for building a
local version of the docs.

Because mkdocs doesn't allow for inheriting a configuration and also
splicing into the `nav`, we'll be looking to duplicate the `nav` for now --
this will likely change eventually as that'll be a maintenance overhead that
we don't really want (will likely look at templating it or something). For
now though, let's look at the best way of splitting things up and seeing how
we can generate two different versions of the docs.
2023-02-06 13:29:49 +00:00