Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools

annotate docs/conf.py @ 301:376c9f97b1cc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 18 Sep 2022 18:49:13 +0200
parents 901b0e3c0dab
children 23bcbbbd99ea
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 # Configuration file for the Sphinx documentation builder.
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2 #
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 # This file only contains a selection of the most common options. For a full
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 # list see the documentation:
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5 # https://www.sphinx-doc.org/en/master/usage/configuration.html
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 # -- Path setup --------------------------------------------------------------
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 # If extensions (or modules to document with autodoc) are in another directory,
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10 # add these directories to sys.path here. If the directory is relative to the
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11 # documentation root, use os.path.abspath to make it absolute, like shown here.
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12 #
291
f2b4edf5f6a3 Docs: read the version from the Makefile
Franz Glasner <fzglas.hg@dom66.de>
parents: 287
diff changeset
13 import os
f2b4edf5f6a3 Docs: read the version from the Makefile
Franz Glasner <fzglas.hg@dom66.de>
parents: 287
diff changeset
14 import re
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 # import sys
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16 # sys.path.insert(0, os.path.abspath('.'))
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
18
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19 # -- Project information -----------------------------------------------------
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21 project = 'local-bsdtools'
280
d9f0c8e00019 Adjust documentation copyright start: 2017
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
22 copyright = '2017-2022, Franz Glasner'
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23 author = 'Franz Glasner'
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
24
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25 # The full version, including alpha/beta/rc tags
291
f2b4edf5f6a3 Docs: read the version from the Makefile
Franz Glasner <fzglas.hg@dom66.de>
parents: 287
diff changeset
26 with open(os.path.join(os.path.dirname(__file__),
f2b4edf5f6a3 Docs: read the version from the Makefile
Franz Glasner <fzglas.hg@dom66.de>
parents: 287
diff changeset
27 "..",
f2b4edf5f6a3 Docs: read the version from the Makefile
Franz Glasner <fzglas.hg@dom66.de>
parents: 287
diff changeset
28 "Makefile"), "rb") as f:
f2b4edf5f6a3 Docs: read the version from the Makefile
Franz Glasner <fzglas.hg@dom66.de>
parents: 287
diff changeset
29 release = re.search(b"^PORTVERSION\s*=\s*(\S+)",
f2b4edf5f6a3 Docs: read the version from the Makefile
Franz Glasner <fzglas.hg@dom66.de>
parents: 287
diff changeset
30 f.read(),
f2b4edf5f6a3 Docs: read the version from the Makefile
Franz Glasner <fzglas.hg@dom66.de>
parents: 287
diff changeset
31 re.MULTILINE).group(1).decode("ascii")
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 # -- General configuration ---------------------------------------------------
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36 # Add any Sphinx extension module names here, as strings. They can be
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38 # ones.
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39 extensions = [
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40 ]
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
42 # Add any paths that contain templates here, relative to this directory.
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43 templates_path = ['_templates']
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45 # List of patterns, relative to source directory, that match files and
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46 # directories to ignore when looking for source files.
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47 # This pattern also affects html_static_path and html_extra_path.
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
51 # -- Options for HTML output -------------------------------------------------
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
53 # The theme to use for HTML and HTML Help pages. See the documentation for
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54 # a list of builtin themes.
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55 #
287
994172263c6e Use the "haiku" theme now
Franz Glasner <fzglas.hg@dom66.de>
parents: 286
diff changeset
56 html_theme = 'haiku'
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
57
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58 # Add any paths that contain custom static files (such as style sheets) here,
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
59 # relative to this directory. They are copied after the builtin static files,
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
60 # so a file named "default.css" will overwrite the builtin "default.css".
280
d9f0c8e00019 Adjust documentation copyright start: 2017
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
61 html_static_path = ['_static']
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
62
287
994172263c6e Use the "haiku" theme now
Franz Glasner <fzglas.hg@dom66.de>
parents: 286
diff changeset
63 html_show_sourcelink = False
994172263c6e Use the "haiku" theme now
Franz Glasner <fzglas.hg@dom66.de>
parents: 286
diff changeset
64
994172263c6e Use the "haiku" theme now
Franz Glasner <fzglas.hg@dom66.de>
parents: 286
diff changeset
65 # For the Haiku title
994172263c6e Use the "haiku" theme now
Franz Glasner <fzglas.hg@dom66.de>
parents: 286
diff changeset
66 html_short_title = "%s %s" % (project, release)
994172263c6e Use the "haiku" theme now
Franz Glasner <fzglas.hg@dom66.de>
parents: 286
diff changeset
67
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
68
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
69 # -- Options for manual page output ------------------------------------------
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
70
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
71 # One entry per manual page. List of tuples
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
72 # (source start file, name, description, authors, manual section).
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
73 man_pages = [
298
41f32fdbecf3 Wording in manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 297
diff changeset
74 ("man/man8/local-bsdtools", "local-bsdtools", 'FreeBSD administration helper tools v%s' % release, [author], 8),
41f32fdbecf3 Wording in manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 297
diff changeset
75 ("man/man8/ftjail", "ftjail", "Management of Thin Jails", [author], 8),
295
11e6e3442df0 Manual page for "ftjail snapshot-tmpl"
Franz Glasner <fzglas.hg@dom66.de>
parents: 294
diff changeset
76 ("man/man8/ftjail-copy-skel", "ftjail-copy-skel", "Recursively copy skeleton contents", [author], 8),
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 300
diff changeset
77 ("man/man8/ftjail-datasets-tmpl", "ftjail-datasets-tmpl", "Create ZFS datasets for new Thin Jails using base and skeleton", [author], 8),
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 300
diff changeset
78 ("man/man8/ftjail-interlink-tmpl", "ftjail-interlink-tmpl", "Create proper symlinks for \"skeleton\" style Thin Jails", [author], 8),
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 300
diff changeset
79 ("man/man8/ftjail-mount-tmpl", "ftjail-mount-tmpl", "Canonically mount the RO base and the RW skeleton of a Thin Jail", [author], 8),
300
901b0e3c0dab All manual pages for ftjail done
Franz Glasner <fzglas.hg@dom66.de>
parents: 298
diff changeset
80 ("man/man8/ftjail-populate", "ftjail-populate", "Populate a prepared directory structure with the contents of a FreeBSD base system", [author], 8),
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 300
diff changeset
81 ("man/man8/ftjail-snapshot-tmpl", "ftjail-snapshot-tmpl", "Recursively create ZFS snapshots of the RO base datasets and the RW skeleton datasets", [author], 8),
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 300
diff changeset
82 ("man/man8/ftjail-umount-tmpl", "ftjail-umount-tmpl", "Unmount mounted Thin Jail template datasets", [author], 8),
294
c2e2fed957ed - Compute a dynmic list of manual pages
Franz Glasner <fzglas.hg@dom66.de>
parents: 293
diff changeset
83 ("man/man8/fzfs", "fzfs", "A ZFS management helper tool", [author], 8),
301
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 300
diff changeset
84 ("man/man8/fzfs-mount", "fzfs-mount", "Recursively mount a ZFS dataset and its children", [author], 8),
376c9f97b1cc Synchronize manpage short descriptions (between conf.py and ftjail.rst and fzfs.rst)
Franz Glasner <fzglas.hg@dom66.de>
parents: 300
diff changeset
85 ("man/man8/fzfs-umount", "fzfs-umount", "Recursively unmount a ZFS datasets and its children", [author], 8),
283
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
86 ]
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
87
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
88
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
89 # -- Link to manual pages ----------------------------------------------------
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
90
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
91 manpages_url = "https://www.freebsd.org/cgi/man.cgi?query={page}&sektion={section}"