Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools
changeset 286:258a1dfd52eb
Separate manual page documentation and "normal" HTML documentation.
No "orphaned" source files should be there now.
Also the HTML theme for the is changed from "alabaster" to "agogo".
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Sun, 18 Sep 2022 10:25:55 +0200 |
| parents | 517724af7c68 |
| children | 994172263c6e |
| files | docs/conf.py docs/index.rst docs/man/fzfs-mount.rst docs/man/fzfs-umount.rst docs/man/fzfs.rst docs/man/index.rst docs/man/local-bsdtools.rst |
| diffstat | 7 files changed, 51 insertions(+), 34 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/conf.py Sun Sep 18 09:52:20 2022 +0200 +++ b/docs/conf.py Sun Sep 18 10:25:55 2022 +0200 @@ -47,7 +47,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'agogo' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -60,7 +60,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ("index", "local-bsdtools", 'FreeBSD specific administration helper tools', [author], 8), + ("man/local-bsdtools", "local-bsdtools", 'FreeBSD specific administration helper tools', [author], 8), ("man/fzfs", "fzfs", "A ZFS management helper tool", [author], 8), ("man/fzfs-mount", "fzfs-mount", "Mount ZFS datasets recursively", [author], 8), ("man/fzfs-umount", "fzfs-umount", "Unmount ZFS datasets recursively", [author], 8),
--- a/docs/index.rst Sun Sep 18 09:52:20 2022 +0200 +++ b/docs/index.rst Sun Sep 18 10:25:55 2022 +0200 @@ -4,27 +4,9 @@ sphinx-quickstart on Sat Sep 17 21:32:09 2022. -local-bsdtools -============== - - -See Also --------- +Dokumentation +============= -- :manpage:`bsmtp2dma(8)` -- :manpage:`check-ports(8)` -- :manpage:`fjail(8)` -- :manpage:`ftjail(8)` -- :manpage:`fpkg(8)` -- :manpage:`fzfs(8)` +.. toctree:: - * :manpage:`fzfs-mount(8)` - * :manpage:`fzfs-umount(8)` - - -Environment ------------ - -Because the tools use different helper tools like :command:`zfs` or -:command:`pkg` the relevant environment variables according to this tools -also apply generally. + man/index
--- a/docs/man/fzfs-mount.rst Sun Sep 18 09:52:20 2022 +0200 +++ b/docs/man/fzfs-mount.rst Sun Sep 18 10:25:55 2022 +0200 @@ -1,8 +1,5 @@ .. -*- coding: utf-8; indent-tabs-mode: nil; -*- -:orphan: - - fzfs-mount ==========
--- a/docs/man/fzfs-umount.rst Sun Sep 18 09:52:20 2022 +0200 +++ b/docs/man/fzfs-umount.rst Sun Sep 18 10:25:55 2022 +0200 @@ -1,12 +1,8 @@ .. -*- coding: utf-8; indent-tabs-mode: nil; -*- -:orphan: - - fzfs-umount =========== - Synopsis --------
--- a/docs/man/fzfs.rst Sun Sep 18 09:52:20 2022 +0200 +++ b/docs/man/fzfs.rst Sun Sep 18 10:25:55 2022 +0200 @@ -1,8 +1,5 @@ .. -*- coding: utf-8; indent-tabs-mode: nil; -*- -:orphan: - - fzfs ====
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/index.rst Sun Sep 18 10:25:55 2022 +0200 @@ -0,0 +1,15 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +.. local-bsdtools documentation master file, created by + sphinx-quickstart on Sat Sep 17 21:32:09 2022. + + +Manual Pages +============ + +.. toctree:: + + local-bsdtools + fzfs + fzfs-mount + fzfs-umount
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/local-bsdtools.rst Sun Sep 18 10:25:55 2022 +0200 @@ -0,0 +1,30 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +.. local-bsdtools documentation master file, created by + sphinx-quickstart on Sat Sep 17 21:32:09 2022. + + +local-bsdtools +============== + + +See Also +-------- + +- :manpage:`bsmtp2dma(8)` +- :manpage:`check-ports(8)` +- :manpage:`fjail(8)` +- :manpage:`ftjail(8)` +- :manpage:`fpkg(8)` +- :manpage:`fzfs(8)` + + * :manpage:`fzfs-mount(8)` + * :manpage:`fzfs-umount(8)` + + +Environment +----------- + +Because the tools use different helper tools like :command:`zfs` or +:command:`pkg` the relevant environment variables according to this tools +also apply generally.