Commit Graph

10 Commits

Author SHA1 Message Date
Dave Pearson
ac35c1d1d5 Document TreeNode via Tree itself
There's a couple of other types in the public interface of Tree that should
be teased out, and it feels odd to have one type in one file and a bunch of
others in another. So this sets us up for having them all the same place.
This should make it easier for the reader to find related information.
2023-03-01 13:21:45 +00:00
Dave Pearson
87f216980d Add the Welcome widget to the documentation
While it's arguably not the most useful widget, it's in the code, exported,
and can be seen by people; I feel it should be in the documentation. I've
ensured that it also links to Placeholder given it sort of is a Placeholder
and so people might arrive at it first and it makes sense to redirect them
to something more comprehensive.
2023-03-01 10:39:30 +00:00
Dave Pearson
ce5b02522e Document AwaitRemove 2023-02-28 12:50:41 +00:00
Dave Pearson
316faf9e45 Add width reference documentation for radio set 2023-02-23 15:31:32 +00:00
Dave Pearson
a821b2f8f6 Add width reference documentation for radio buttons
A large part of the code to go with this is to show off a radio set; I feel
it makes sense to use the same code for both bits of documentation given
that a radio button only really makes sense inside a radio set.
2023-02-23 15:14:25 +00:00
Dave Pearson
3fd3d272ce Add the widget reference for Checkbox 2023-02-23 14:26:11 +00:00
Dave Pearson
f52aac4952 Initial work on adding toggle buttons to the documentation
This just gets the API docs into place, and tidies up some of the docstirngs.
2023-02-23 13:27:27 +00:00
Will McGugan
71d0017ef9 docs and refactor 2023-02-14 15:22:15 +00:00
Dave Pearson
584df4530c Merge branch 'main' into package-docs 2023-02-09 15:49:56 +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