# HG changeset patch # User Franz Glasner # Date 1663489555 -7200 # Node ID 258a1dfd52eba5cd3bfd25ca3c27a58f2b00b9c5 # Parent 517724af7c685c30b2e245a28cc2d9059337dbfa 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". diff -r 517724af7c68 -r 258a1dfd52eb docs/conf.py --- 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), diff -r 517724af7c68 -r 258a1dfd52eb docs/index.rst --- 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 diff -r 517724af7c68 -r 258a1dfd52eb docs/man/fzfs-mount.rst --- 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 ========== diff -r 517724af7c68 -r 258a1dfd52eb docs/man/fzfs-umount.rst --- 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 -------- diff -r 517724af7c68 -r 258a1dfd52eb docs/man/fzfs.rst --- 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 ==== diff -r 517724af7c68 -r 258a1dfd52eb docs/man/index.rst --- /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 diff -r 517724af7c68 -r 258a1dfd52eb docs/man/local-bsdtools.rst --- /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.