mirror of
https://github.com/nix-community/home-manager.git
synced 2025-11-30 14:11:02 +01:00
treewide: convert options with lists to Markdown
`nix-doc-munge` can't handle these, which is understandable as I can barely handle them either. There are a few infelicities here: the current processor can't handle multiple terms to one description in a description list so they get comma-separated in one case, and one case that should ideally render as a `<figure>` with a `<figcaption>` in HTML is reduced to a paragraph with some `<strong>` text. (Which, in fairness, is how it rendered in practice with the DocBook anyway.) The docs generator has since been updated to handle figures, but we can't use it until moving off DocBook output.
This commit is contained in:
Emily
parent
9e4a73c25e
commit
21c700d14b
13 changed files with 341 additions and 531 deletions
|
|
@ -57,46 +57,25 @@ in
|
|||
display = mkOption {
|
||||
type = types.enum [ "silent" "notify" "show" ];
|
||||
default = "notify";
|
||||
description = ''
|
||||
description = lib.mdDoc ''
|
||||
How unread and relevant news should be presented when
|
||||
running <command>home-manager build</command> and
|
||||
<command>home-manager switch</command>.
|
||||
|
||||
</para><para>
|
||||
running {command}`home-manager build` and
|
||||
{command}`home-manager switch`.
|
||||
|
||||
The options are
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><literal>silent</literal></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Do not print anything during build or switch. The
|
||||
<command>home-manager news</command> command still
|
||||
works for viewing the entries.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>notify</literal></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The number of unread and relevant news entries will be
|
||||
printed to standard output. The <command>home-manager
|
||||
news</command> command can later be used to view the
|
||||
entries.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>show</literal></term>
|
||||
<listitem>
|
||||
<para>
|
||||
A pager showing unread news entries is opened.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
`silent`
|
||||
: Do not print anything during build or switch. The
|
||||
{command}`home-manager news` command still
|
||||
works for viewing the entries.
|
||||
|
||||
`notify`
|
||||
: The number of unread and relevant news entries will be
|
||||
printed to standard output. The {command}`home-manager
|
||||
news` command can later be used to view the entries.
|
||||
|
||||
`show`
|
||||
: A pager showing unread news entries is opened.
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -55,35 +55,27 @@ in {
|
|||
[ "libsForQt5" "plasma-integration" ]
|
||||
[ "libsForQt5" "systemsettings" ]
|
||||
];
|
||||
description = ''
|
||||
Platform theme to use for Qt applications.</para>
|
||||
<para>The options are
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><literal>gtk</literal></term>
|
||||
<listitem><para>Use GTK theme with
|
||||
<link xlink:href="https://github.com/qt/qtstyleplugins">qtstyleplugins</link>
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>gnome</literal></term>
|
||||
<listitem><para>Use GNOME theme with
|
||||
<link xlink:href="https://github.com/FedoraQt/QGnomePlatform">qgnomeplatform</link>
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>qtct</literal></term>
|
||||
<listitem><para>Use Qt style set using
|
||||
<link xlink:href="https://github.com/desktop-app/qt5ct">qt5ct</link>
|
||||
and
|
||||
<link xlink:href="https://github.com/trialuser02/qt6ct">qt6ct</link>
|
||||
applications</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>kde</literal></term>
|
||||
<listitem><para>Use Qt settings from Plasma</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
description = lib.mdDoc ''
|
||||
Platform theme to use for Qt applications.
|
||||
|
||||
The options are
|
||||
|
||||
`gtk`
|
||||
: Use GTK theme with
|
||||
[`qtstyleplugins`](https://github.com/qt/qtstyleplugins)
|
||||
|
||||
`gnome`
|
||||
: Use GNOME theme with
|
||||
[`qgnomeplatform`](https://github.com/FedoraQt/QGnomePlatform)
|
||||
|
||||
`qtct`
|
||||
: Use Qt style set using
|
||||
[`qt5ct`](https://github.com/desktop-app/qt5ct)
|
||||
and [`qt6ct`](https://github.com/trialuser02/qt6ct)
|
||||
applications
|
||||
|
||||
`kde`
|
||||
: Use Qt settings from Plasma
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
@ -100,45 +92,26 @@ in {
|
|||
[ "libsForQt5" "qtstyleplugin-kvantum" ]
|
||||
[ "qt6Packages" "qtstyleplugin-kvantum" ]
|
||||
];
|
||||
description = ''
|
||||
description = lib.mdDoc ''
|
||||
Style to use for Qt5/Qt6 applications. Case-insensitive.
|
||||
</para>
|
||||
<para>Some examples are
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><literal>adwaita</literal></term>
|
||||
<term><literal>adwaita-dark</literal></term>
|
||||
<term><literal>adwaita-highcontrast</literal></term>
|
||||
<term><literal>adwaita-highcontrastinverse</literal></term>
|
||||
<listitem><para>Use the Adwaita style from
|
||||
<link xlink:href="https://github.com/FedoraQt/adwaita-qt">adwaita</link>
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>breeze</literal></term>
|
||||
<listitem><para>Use the Breeze style from
|
||||
<link xlink:href="https://github.com/KDE/breeze">breeze</link>
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>bb10bright</literal></term>
|
||||
<term><literal>bb10dark</literal></term>
|
||||
<term><literal>cde</literal></term>
|
||||
<term><literal>cleanlooks</literal></term>
|
||||
<term><literal>gtk2</literal></term>
|
||||
<term><literal>motif</literal></term>
|
||||
<term><literal>plastique</literal></term>
|
||||
<listitem><para>Use styles from
|
||||
<link xlink:href="https://github.com/qt/qtstyleplugins">qtstyleplugins</link>
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>kvantum</literal></term>
|
||||
<listitem><para>Use styles from
|
||||
<link xlink:href="https://github.com/tsujan/Kvantum">kvantum</link>
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
Some examples are
|
||||
|
||||
`adwaita`, `adwaita-dark`, `adwaita-highcontrast`, `adwaita-highcontrastinverse`
|
||||
: Use the Adwaita style from
|
||||
[`adwaita-qt`](https://github.com/FedoraQt/adwaita-qt)
|
||||
|
||||
`breeze`
|
||||
: Use the Breeze style from
|
||||
[`breeze`](https://github.com/KDE/breeze)
|
||||
|
||||
`bb10bright`, `bb10dark`, `cde`, `cleanlooks`, `gtk2`, `motif`, `plastique`
|
||||
: Use styles from
|
||||
[`qtstyleplugins`](https://github.com/qt/qtstyleplugins)
|
||||
|
||||
`kvantum`
|
||||
: Use styles from
|
||||
[`kvantum`](https://github.com/tsujan/Kvantum)
|
||||
'';
|
||||
};
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue