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

annotate docs/conf.py @ 286:258a1dfd52eb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 106cd5d9da7e
children 994172263c6e
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 #
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13 # import os
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14 # import sys
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 # 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
16
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 # -- Project information -----------------------------------------------------
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20 project = 'local-bsdtools'
280
d9f0c8e00019 Adjust documentation copyright start: 2017
Franz Glasner <fzglas.hg@dom66.de>
parents: 279
diff changeset
21 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
22 author = 'Franz Glasner'
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
24 # The full version, including alpha/beta/rc tags
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25 release = '0.18.2'
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
26
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28 # -- General configuration ---------------------------------------------------
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
29
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
30 # 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
31 # 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
32 # ones.
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33 extensions = [
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 ]
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 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
37 templates_path = ['_templates']
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39 # 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
40 # 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
41 # 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
42 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
43
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 # -- Options for HTML output -------------------------------------------------
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47 # 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
48 # 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
49 #
286
258a1dfd52eb Separate manual page documentation and "normal" HTML documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents: 284
diff changeset
50 html_theme = 'agogo'
279
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
51
86d8929e4747 Add the Sphinx documentation sources as generated by sphinx-quickstart
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52 # 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
53 # 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
54 # 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
55 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
56
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
57
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
58 # -- 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
59
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
60 # 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
61 # (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
62 man_pages = [
286
258a1dfd52eb Separate manual page documentation and "normal" HTML documentation.
Franz Glasner <fzglas.hg@dom66.de>
parents: 284
diff changeset
63 ("man/local-bsdtools", "local-bsdtools", 'FreeBSD specific administration helper tools', [author], 8),
284
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
64 ("man/fzfs", "fzfs", "A ZFS management helper tool", [author], 8),
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
65 ("man/fzfs-mount", "fzfs-mount", "Mount ZFS datasets recursively", [author], 8),
106cd5d9da7e Put all manual pages into section 8 (FreeBSD System Manager's Manual)
Franz Glasner <fzglas.hg@dom66.de>
parents: 283
diff changeset
66 ("man/fzfs-umount", "fzfs-umount", "Unmount ZFS datasets recursively", [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
67 ]
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
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
70 # -- 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
71
1fc3b04b39fa Build and package manual pages for fzfs, fzfs-mount and fzfs-umount.
Franz Glasner <fzglas.hg@dom66.de>
parents: 280
diff changeset
72 manpages_url = "https://www.freebsd.org/cgi/man.cgi?query={page}&sektion={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