From f98208f250085e7b683d0c7a82ea4ac2e3fbc11b Mon Sep 17 00:00:00 2001 From: Darko Poljak Date: Thu, 30 Jun 2016 12:09:07 +0200 Subject: [PATCH 1/2] Make man pages SEE ALSO by convention. Improve docs building. --- .gitignore | 3 ++- cdist/conf/type/__apt_key/man.rst | 6 ------ cdist/conf/type/__apt_key_uri/man.rst | 6 ------ cdist/conf/type/__apt_norecommends/man.rst | 6 ------ cdist/conf/type/__apt_ppa/man.rst | 6 ------ cdist/conf/type/__apt_source/man.rst | 6 ------ cdist/conf/type/__apt_update_index/man.rst | 6 ------ cdist/conf/type/__block/man.rst | 6 ------ cdist/conf/type/__ccollect_source/man.rst | 7 +------ cdist/conf/type/__cdist/man.rst | 6 ------ cdist/conf/type/__cdistmarker/man.rst | 6 ------ cdist/conf/type/__config_file/man.rst | 5 +---- cdist/conf/type/__consul/man.rst | 6 ------ cdist/conf/type/__consul_agent/man.rst | 5 +---- cdist/conf/type/__consul_check/man.rst | 5 +---- cdist/conf/type/__consul_reload/man.rst | 6 ------ cdist/conf/type/__consul_service/man.rst | 5 +---- cdist/conf/type/__consul_template/man.rst | 5 +---- .../type/__consul_template_template/man.rst | 6 +----- cdist/conf/type/__consul_watch_checks/man.rst | 7 ++----- cdist/conf/type/__consul_watch_event/man.rst | 7 ++----- cdist/conf/type/__consul_watch_key/man.rst | 7 ++----- .../type/__consul_watch_keyprefix/man.rst | 6 ++---- cdist/conf/type/__consul_watch_nodes/man.rst | 7 ++----- .../conf/type/__consul_watch_service/man.rst | 6 ++---- .../conf/type/__consul_watch_services/man.rst | 7 ++----- cdist/conf/type/__cron/man.rst | 5 +---- .../type/__debconf_set_selections/man.rst | 6 +----- cdist/conf/type/__directory/man.rst | 6 ------ cdist/conf/type/__dog_vdi/man.rst | 5 +---- cdist/conf/type/__file/man.rst | 6 ------ cdist/conf/type/__firewalld_rule/man.rst | 6 +----- cdist/conf/type/__git/man.rst | 6 ------ cdist/conf/type/__group/man.rst | 6 ------ cdist/conf/type/__hostname/man.rst | 6 ------ cdist/conf/type/__iptables_apply/man.rst | 6 +----- cdist/conf/type/__iptables_rule/man.rst | 6 +----- cdist/conf/type/__issue/man.rst | 6 ------ cdist/conf/type/__jail/man.rst | 3 +-- cdist/conf/type/__jail_freebsd10/man.rst | 3 +-- cdist/conf/type/__jail_freebsd9/man.rst | 3 +-- cdist/conf/type/__key_value/man.rst | 6 ------ cdist/conf/type/__line/man.rst | 5 +---- cdist/conf/type/__link/man.rst | 6 ------ cdist/conf/type/__locale/man.rst | 5 +---- cdist/conf/type/__motd/man.rst | 6 ------ cdist/conf/type/__mount/man.rst | 6 ------ cdist/conf/type/__mysql_database/man.rst | 6 ------ cdist/conf/type/__package/man.rst | 6 ------ cdist/conf/type/__package_apt/man.rst | 5 +---- cdist/conf/type/__package_emerge/man.rst | 6 +----- .../__package_emerge_dependencies/man.rst | 6 +----- cdist/conf/type/__package_luarocks/man.rst | 5 +---- cdist/conf/type/__package_opkg/man.rst | 5 +---- cdist/conf/type/__package_pacman/man.rst | 5 +---- cdist/conf/type/__package_pip/man.rst | 5 +---- cdist/conf/type/__package_pkg_freebsd/man.rst | 5 +---- cdist/conf/type/__package_pkg_openbsd/man.rst | 5 +---- .../conf/type/__package_pkgng_freebsd/man.rst | 5 +---- cdist/conf/type/__package_rubygem/man.rst | 5 +---- .../conf/type/__package_update_index/man.rst | 6 ------ cdist/conf/type/__package_upgrade_all/man.rst | 6 ------ cdist/conf/type/__package_yum/man.rst | 5 +---- cdist/conf/type/__package_zypper/man.rst | 5 +---- cdist/conf/type/__pacman_conf/man.rst | 5 +---- .../conf/type/__pacman_conf_integrate/man.rst | 5 +---- cdist/conf/type/__pf_apply/man.rst | 6 +----- cdist/conf/type/__pf_ruleset/man.rst | 5 +---- cdist/conf/type/__postfix/man.rst | 6 ------ cdist/conf/type/__postfix_master/man.rst | 5 +---- cdist/conf/type/__postfix_postconf/man.rst | 5 +---- cdist/conf/type/__postfix_postmap/man.rst | 6 ------ cdist/conf/type/__postfix_reload/man.rst | 6 ------ cdist/conf/type/__postgres_database/man.rst | 5 +---- cdist/conf/type/__postgres_role/man.rst | 4 +--- cdist/conf/type/__process/man.rst | 5 +---- cdist/conf/type/__pyvenv/man.rst | 6 ------ cdist/conf/type/__qemu_img/man.rst | 5 +---- cdist/conf/type/__rbenv/man.rst | 6 ------ cdist/conf/type/__rsync/man.rst | 5 +---- cdist/conf/type/__rvm/man.rst | 8 ++----- cdist/conf/type/__rvm_gem/man.rst | 8 ++----- cdist/conf/type/__rvm_gemset/man.rst | 8 ++----- cdist/conf/type/__rvm_ruby/man.rst | 8 ++----- cdist/conf/type/__ssh_authorized_key/man.rst | 5 +---- cdist/conf/type/__ssh_authorized_keys/man.rst | 5 +---- cdist/conf/type/__ssh_dot_ssh/man.rst | 5 +---- cdist/conf/type/__staged_file/man.rst | 5 +---- cdist/conf/type/__start_on_boot/man.rst | 5 +---- cdist/conf/type/__timezone/man.rst | 6 ------ cdist/conf/type/__update_alternatives/man.rst | 6 +----- cdist/conf/type/__user/man.rst | 5 +---- cdist/conf/type/__user_groups/man.rst | 6 ------ cdist/conf/type/__yum_repo/man.rst | 6 ------ cdist/conf/type/__zypper_repo/man.rst | 6 ------ cdist/conf/type/__zypper_service/man.rst | 6 ------ docs/man/Makefile | 7 +++++-- docs/man/cdist-install.rst | 21 ++++++++++++++----- docs/man/conf.py | 6 ------ docs/man/man1/cdist.rst | 4 ---- 100 files changed, 94 insertions(+), 485 deletions(-) diff --git a/.gitignore b/.gitignore index 6152451b..3bbc4e99 100644 --- a/.gitignore +++ b/.gitignore @@ -20,8 +20,9 @@ MANIFEST dist/ cdist/version.py -#sphinx build dir +# sphinx build dirs, cache _build/ +docs/dist # Packaging: Archlinux /PKGBUILD diff --git a/cdist/conf/type/__apt_key/man.rst b/cdist/conf/type/__apt_key/man.rst index 01d4eea4..488a1a06 100644 --- a/cdist/conf/type/__apt_key/man.rst +++ b/cdist/conf/type/__apt_key/man.rst @@ -48,12 +48,6 @@ EXAMPLES __apt_key UbuntuArchiveKey --keyid 437D05B5 --keyserver keyserver.ubuntu.com -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__apt_key_uri/man.rst b/cdist/conf/type/__apt_key_uri/man.rst index 9c0042bb..e8741dff 100644 --- a/cdist/conf/type/__apt_key_uri/man.rst +++ b/cdist/conf/type/__apt_key_uri/man.rst @@ -38,12 +38,6 @@ EXAMPLES --state present -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__apt_norecommends/man.rst b/cdist/conf/type/__apt_norecommends/man.rst index 0198d7bd..7ef496c3 100644 --- a/cdist/conf/type/__apt_norecommends/man.rst +++ b/cdist/conf/type/__apt_norecommends/man.rst @@ -29,12 +29,6 @@ EXAMPLES __apt_norecommends -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__apt_ppa/man.rst b/cdist/conf/type/__apt_ppa/man.rst index e91e82fe..978e1252 100644 --- a/cdist/conf/type/__apt_ppa/man.rst +++ b/cdist/conf/type/__apt_ppa/man.rst @@ -37,12 +37,6 @@ EXAMPLES __apt_ppa ppa:sans-intern/missing-bits --state absent -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__apt_source/man.rst b/cdist/conf/type/__apt_source/man.rst index e4916515..31f2e9e6 100644 --- a/cdist/conf/type/__apt_source/man.rst +++ b/cdist/conf/type/__apt_source/man.rst @@ -56,12 +56,6 @@ EXAMPLES --component partner --state present -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__apt_update_index/man.rst b/cdist/conf/type/__apt_update_index/man.rst index e0672620..326d4c2f 100644 --- a/cdist/conf/type/__apt_update_index/man.rst +++ b/cdist/conf/type/__apt_update_index/man.rst @@ -28,12 +28,6 @@ EXAMPLES __apt_update_index -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__block/man.rst b/cdist/conf/type/__block/man.rst index 3b7c3439..6d7b8ba1 100644 --- a/cdist/conf/type/__block/man.rst +++ b/cdist/conf/type/__block/man.rst @@ -69,12 +69,6 @@ EXAMPLES DONE -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__ccollect_source/man.rst b/cdist/conf/type/__ccollect_source/man.rst index 5d980bda..cdacd31c 100644 --- a/cdist/conf/type/__ccollect_source/man.rst +++ b/cdist/conf/type/__ccollect_source/man.rst @@ -53,12 +53,7 @@ EXAMPLES SEE ALSO -------- -ccollect(1) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. -ccollect documentation at: -. +:manpage:`ccollect`\ (1) AUTHORS diff --git a/cdist/conf/type/__cdist/man.rst b/cdist/conf/type/__cdist/man.rst index ad544c5c..1bfb35c5 100644 --- a/cdist/conf/type/__cdist/man.rst +++ b/cdist/conf/type/__cdist/man.rst @@ -50,12 +50,6 @@ EXAMPLES __cdist --source "git://git.schottelius.org/cdist" /home/cdist/cdist -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Nico Schottelius diff --git a/cdist/conf/type/__cdistmarker/man.rst b/cdist/conf/type/__cdistmarker/man.rst index 156aed62..cb4dace8 100644 --- a/cdist/conf/type/__cdistmarker/man.rst +++ b/cdist/conf/type/__cdistmarker/man.rst @@ -42,12 +42,6 @@ EXAMPLES __cdistmarker --destination /tmp/cdist_marker --format '+%s' -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Daniel Maher diff --git a/cdist/conf/type/__config_file/man.rst b/cdist/conf/type/__config_file/man.rst index acb3c848..b9d58979 100644 --- a/cdist/conf/type/__config_file/man.rst +++ b/cdist/conf/type/__config_file/man.rst @@ -48,10 +48,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__file(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__file`\ (7) AUTHORS diff --git a/cdist/conf/type/__consul/man.rst b/cdist/conf/type/__consul/man.rst index 4096a233..c15ded45 100644 --- a/cdist/conf/type/__consul/man.rst +++ b/cdist/conf/type/__consul/man.rst @@ -41,12 +41,6 @@ EXAMPLES --version 0.4.1 -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__consul_agent/man.rst b/cdist/conf/type/__consul_agent/man.rst index 7a15a058..5a35a2cc 100644 --- a/cdist/conf/type/__consul_agent/man.rst +++ b/cdist/conf/type/__consul_agent/man.rst @@ -165,10 +165,7 @@ EXAMPLES SEE ALSO -------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. -consul documentation at: -. +consul documentation at: . AUTHORS diff --git a/cdist/conf/type/__consul_check/man.rst b/cdist/conf/type/__consul_check/man.rst index 87e2d7a9..c0d0b459 100644 --- a/cdist/conf/type/__consul_check/man.rst +++ b/cdist/conf/type/__consul_check/man.rst @@ -62,10 +62,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__consul_agent(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__consul_agent`\ (7) AUTHORS diff --git a/cdist/conf/type/__consul_reload/man.rst b/cdist/conf/type/__consul_reload/man.rst index 62b08c7f..410bd5e6 100644 --- a/cdist/conf/type/__consul_reload/man.rst +++ b/cdist/conf/type/__consul_reload/man.rst @@ -29,12 +29,6 @@ EXAMPLES __consul_reload -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__consul_service/man.rst b/cdist/conf/type/__consul_service/man.rst index 560266a4..75b06aa0 100644 --- a/cdist/conf/type/__consul_service/man.rst +++ b/cdist/conf/type/__consul_service/man.rst @@ -66,10 +66,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__consul_agent(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__consul_agent`\ (7) AUTHORS diff --git a/cdist/conf/type/__consul_template/man.rst b/cdist/conf/type/__consul_template/man.rst index d2d484e5..a6228cad 100644 --- a/cdist/conf/type/__consul_template/man.rst +++ b/cdist/conf/type/__consul_template/man.rst @@ -125,10 +125,7 @@ EXAMPLES SEE ALSO -------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. -consul documentation at: -. +consul documentation at: . AUTHORS diff --git a/cdist/conf/type/__consul_template_template/man.rst b/cdist/conf/type/__consul_template_template/man.rst index 9932346b..b54f759e 100644 --- a/cdist/conf/type/__consul_template_template/man.rst +++ b/cdist/conf/type/__consul_template_template/man.rst @@ -59,11 +59,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__consul_template(7) `_, -`cdist-type__consul_template_config(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__consul_template`\ (7), :manpage:`cdist-type__consul_template_config`\ (7) AUTHORS diff --git a/cdist/conf/type/__consul_watch_checks/man.rst b/cdist/conf/type/__consul_watch_checks/man.rst index dc3c9669..ec04b0b3 100644 --- a/cdist/conf/type/__consul_watch_checks/man.rst +++ b/cdist/conf/type/__consul_watch_checks/man.rst @@ -55,12 +55,9 @@ EXAMPLES SEE ALSO -------- -`cdist-type__consul_agent(7) `_ +:manpage:`cdist-type__consul_agent`\ (7) -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. -consul documentation at: -. +consul documentation at: . AUTHORS diff --git a/cdist/conf/type/__consul_watch_event/man.rst b/cdist/conf/type/__consul_watch_event/man.rst index 73b16754..664a19a2 100644 --- a/cdist/conf/type/__consul_watch_event/man.rst +++ b/cdist/conf/type/__consul_watch_event/man.rst @@ -48,12 +48,9 @@ EXAMPLES SEE ALSO -------- -`cdist-type__consul_agent(7) `_ +:manpage:`cdist-type__consul_agent`\ (7) -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. -consul documentation at: -. +consul documentation at: . AUTHORS diff --git a/cdist/conf/type/__consul_watch_key/man.rst b/cdist/conf/type/__consul_watch_key/man.rst index c258119c..0f90245c 100644 --- a/cdist/conf/type/__consul_watch_key/man.rst +++ b/cdist/conf/type/__consul_watch_key/man.rst @@ -45,12 +45,9 @@ EXAMPLES SEE ALSO -------- -`cdist-type__consul_agent(7) `_ +:manpage:`cdist-type__consul_agent`\ (7) -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. -consul documentation at: -. +consul documentation at: . AUTHORS diff --git a/cdist/conf/type/__consul_watch_keyprefix/man.rst b/cdist/conf/type/__consul_watch_keyprefix/man.rst index 950c0a26..65fa16af 100644 --- a/cdist/conf/type/__consul_watch_keyprefix/man.rst +++ b/cdist/conf/type/__consul_watch_keyprefix/man.rst @@ -45,11 +45,9 @@ EXAMPLES SEE ALSO -------- -`cdist-type__consul_agent(7) `_ +:manpage:`cdist-type__consul_agent`\ (7) -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. -consule documentation at: . +consul documentation at: . AUTHORS diff --git a/cdist/conf/type/__consul_watch_nodes/man.rst b/cdist/conf/type/__consul_watch_nodes/man.rst index a44dada4..5a5bdbd2 100644 --- a/cdist/conf/type/__consul_watch_nodes/man.rst +++ b/cdist/conf/type/__consul_watch_nodes/man.rst @@ -41,12 +41,9 @@ EXAMPLES SEE ALSO -------- -`cdist-type__consul_agent(7) `_ +:manpage:`cdist-type__consul_agent`\ (7) -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. -consul documentation at: -. +consul documentation at: . AUTHORS diff --git a/cdist/conf/type/__consul_watch_service/man.rst b/cdist/conf/type/__consul_watch_service/man.rst index fa6450fe..38ee501a 100644 --- a/cdist/conf/type/__consul_watch_service/man.rst +++ b/cdist/conf/type/__consul_watch_service/man.rst @@ -65,11 +65,9 @@ EXAMPLES SEE ALSO -------- -`cdist-type__consul_agent(7) `_ +:manpage:`cdist-type__consul_agent`\ (7) -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. -consule documentation at: . +consul documentation at: . AUTHORS diff --git a/cdist/conf/type/__consul_watch_services/man.rst b/cdist/conf/type/__consul_watch_services/man.rst index db561593..41b115ae 100644 --- a/cdist/conf/type/__consul_watch_services/man.rst +++ b/cdist/conf/type/__consul_watch_services/man.rst @@ -41,12 +41,9 @@ EXAMPLES SEE ALSO -------- -`cdist-type__consul_agent(7) `_ +:manpage:`cdist-type__consul_agent`\ (7) -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. -consul documentation at: -. +consul documentation at: . AUTHORS diff --git a/cdist/conf/type/__cron/man.rst b/cdist/conf/type/__cron/man.rst index e8f32c52..4b9cb83d 100644 --- a/cdist/conf/type/__cron/man.rst +++ b/cdist/conf/type/__cron/man.rst @@ -68,10 +68,7 @@ EXAMPLES SEE ALSO -------- -crontab(5) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`crontab`\ (5) AUTHORS diff --git a/cdist/conf/type/__debconf_set_selections/man.rst b/cdist/conf/type/__debconf_set_selections/man.rst index 27e037e7..b7e5f901 100644 --- a/cdist/conf/type/__debconf_set_selections/man.rst +++ b/cdist/conf/type/__debconf_set_selections/man.rst @@ -37,11 +37,7 @@ EXAMPLES SEE ALSO -------- -debconf-set-selections(1), -`cdist-type__update_alternatives(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`debconf-set-selections`\ (1), :manpage:`cdist-type__update_alternatives`\ (7) AUTHORS diff --git a/cdist/conf/type/__directory/man.rst b/cdist/conf/type/__directory/man.rst index abb07eff..e756b1d6 100644 --- a/cdist/conf/type/__directory/man.rst +++ b/cdist/conf/type/__directory/man.rst @@ -88,12 +88,6 @@ EXAMPLES --owner root --group root --mode 0755 --state present -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Nico Schottelius diff --git a/cdist/conf/type/__dog_vdi/man.rst b/cdist/conf/type/__dog_vdi/man.rst index b0f700c6..65bea479 100644 --- a/cdist/conf/type/__dog_vdi/man.rst +++ b/cdist/conf/type/__dog_vdi/man.rst @@ -43,10 +43,7 @@ EXAMPLES SEE ALSO -------- -qemu(1), dog(8) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`qemu`\ (1), :manpage:`dog`\ (8) AUTHORS diff --git a/cdist/conf/type/__file/man.rst b/cdist/conf/type/__file/man.rst index fa71e5ce..e21390c7 100644 --- a/cdist/conf/type/__file/man.rst +++ b/cdist/conf/type/__file/man.rst @@ -99,12 +99,6 @@ EXAMPLES DONE -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Nico Schottelius diff --git a/cdist/conf/type/__firewalld_rule/man.rst b/cdist/conf/type/__firewalld_rule/man.rst index 2d1f5589..414eb7e9 100644 --- a/cdist/conf/type/__firewalld_rule/man.rst +++ b/cdist/conf/type/__firewalld_rule/man.rst @@ -65,11 +65,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__iptables_rule(7) `_, -firewalld(8) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__iptables_rule`\ (7), :manpage:`firewalld`\ (8) AUTHORS diff --git a/cdist/conf/type/__git/man.rst b/cdist/conf/type/__git/man.rst index 2f344a69..c1341ec0 100644 --- a/cdist/conf/type/__git/man.rst +++ b/cdist/conf/type/__git/man.rst @@ -47,12 +47,6 @@ EXAMPLES __git /home/nico/cdist --source git://github.com/telmich/cdist.git --branch 2.1 -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Nico Schottelius diff --git a/cdist/conf/type/__group/man.rst b/cdist/conf/type/__group/man.rst index c6c9d226..daea0909 100644 --- a/cdist/conf/type/__group/man.rst +++ b/cdist/conf/type/__group/man.rst @@ -67,12 +67,6 @@ EXAMPLES __group foobar --gid 1234 --password 'crypted-password-string' -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__hostname/man.rst b/cdist/conf/type/__hostname/man.rst index bfb9d457..ea1186bc 100644 --- a/cdist/conf/type/__hostname/man.rst +++ b/cdist/conf/type/__hostname/man.rst @@ -39,12 +39,6 @@ EXAMPLES __hostname --name some-static-hostname -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__iptables_apply/man.rst b/cdist/conf/type/__iptables_apply/man.rst index 5f4f4dc8..48697f9c 100644 --- a/cdist/conf/type/__iptables_apply/man.rst +++ b/cdist/conf/type/__iptables_apply/man.rst @@ -29,11 +29,7 @@ None (__iptables_apply is used by __iptables_rule) SEE ALSO -------- -`cdist-type__iptables_rule(7) `_, -iptables(8) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__iptables_rule`\ (7), :manpage:`iptables`\ (8) AUTHORS diff --git a/cdist/conf/type/__iptables_rule/man.rst b/cdist/conf/type/__iptables_rule/man.rst index 4d02e1d7..fab6c47a 100644 --- a/cdist/conf/type/__iptables_rule/man.rst +++ b/cdist/conf/type/__iptables_rule/man.rst @@ -50,11 +50,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__iptables_apply(7) `_, -iptables(8) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__iptables_apply`\ (7), :manpage:`iptables`\ (8) AUTHORS diff --git a/cdist/conf/type/__issue/man.rst b/cdist/conf/type/__issue/man.rst index 77f28da2..eacd8378 100644 --- a/cdist/conf/type/__issue/man.rst +++ b/cdist/conf/type/__issue/man.rst @@ -34,12 +34,6 @@ EXAMPLES __issue --source "$__type/files/myfancyissue" -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Nico Schottelius diff --git a/cdist/conf/type/__jail/man.rst b/cdist/conf/type/__jail/man.rst index ba175aa4..756e7660 100644 --- a/cdist/conf/type/__jail/man.rst +++ b/cdist/conf/type/__jail/man.rst @@ -108,8 +108,7 @@ EXAMPLES SEE ALSO -------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`jail`\ (8) AUTHORS diff --git a/cdist/conf/type/__jail_freebsd10/man.rst b/cdist/conf/type/__jail_freebsd10/man.rst index 9916afcb..34dc2198 100644 --- a/cdist/conf/type/__jail_freebsd10/man.rst +++ b/cdist/conf/type/__jail_freebsd10/man.rst @@ -107,8 +107,7 @@ EXAMPLES SEE ALSO -------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`jail`\ (8) AUTHORS diff --git a/cdist/conf/type/__jail_freebsd9/man.rst b/cdist/conf/type/__jail_freebsd9/man.rst index 21266dd8..ca526cd0 100644 --- a/cdist/conf/type/__jail_freebsd9/man.rst +++ b/cdist/conf/type/__jail_freebsd9/man.rst @@ -108,8 +108,7 @@ EXAMPLES SEE ALSO -------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`jail`\ (8) AUTHORS diff --git a/cdist/conf/type/__key_value/man.rst b/cdist/conf/type/__key_value/man.rst index 78e29276..80d6aa89 100644 --- a/cdist/conf/type/__key_value/man.rst +++ b/cdist/conf/type/__key_value/man.rst @@ -81,12 +81,6 @@ This type try to handle as many values as possible, so it doesn't use regexes. So you need to exactly specify the key and delimiter. Delimiter can be of any lenght. -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__line/man.rst b/cdist/conf/type/__line/man.rst index 3a773f6a..1f38a974 100644 --- a/cdist/conf/type/__line/man.rst +++ b/cdist/conf/type/__line/man.rst @@ -61,10 +61,7 @@ EXAMPLES SEE ALSO -------- -grep(1) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`grep`\ (1) AUTHORS diff --git a/cdist/conf/type/__link/man.rst b/cdist/conf/type/__link/man.rst index 0d0f2fad..4560b1af 100644 --- a/cdist/conf/type/__link/man.rst +++ b/cdist/conf/type/__link/man.rst @@ -47,12 +47,6 @@ EXAMPLES __link /opt/plone --state absent -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Nico Schottelius diff --git a/cdist/conf/type/__locale/man.rst b/cdist/conf/type/__locale/man.rst index c555bd00..51ed38df 100644 --- a/cdist/conf/type/__locale/man.rst +++ b/cdist/conf/type/__locale/man.rst @@ -34,10 +34,7 @@ EXAMPLES SEE ALSO -------- -locale(1), localedef(1) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`locale`\ (1), :manpage:`localedef`\ (1) AUTHORS diff --git a/cdist/conf/type/__motd/man.rst b/cdist/conf/type/__motd/man.rst index e1530495..b568985f 100644 --- a/cdist/conf/type/__motd/man.rst +++ b/cdist/conf/type/__motd/man.rst @@ -35,12 +35,6 @@ EXAMPLES __motd --source "$__type/files/my-motd" -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Nico Schottelius diff --git a/cdist/conf/type/__mount/man.rst b/cdist/conf/type/__mount/man.rst index c53457ac..799288af 100644 --- a/cdist/conf/type/__mount/man.rst +++ b/cdist/conf/type/__mount/man.rst @@ -71,12 +71,6 @@ EXAMPLES --options "mfsmaster=mfsmaster.domain.tld,mfssubfolder=/one,nonempty,_netdev" -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__mysql_database/man.rst b/cdist/conf/type/__mysql_database/man.rst index 921df7f3..0e21a8a1 100644 --- a/cdist/conf/type/__mysql_database/man.rst +++ b/cdist/conf/type/__mysql_database/man.rst @@ -36,12 +36,6 @@ EXAMPLES __mysql_database "cdist" --name "cdist" --user "myuser" --password "mypwd" -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Benedikt Koeppel diff --git a/cdist/conf/type/__package/man.rst b/cdist/conf/type/__package/man.rst index fe806a53..91319e18 100644 --- a/cdist/conf/type/__package/man.rst +++ b/cdist/conf/type/__package/man.rst @@ -51,12 +51,6 @@ EXAMPLES __package vim --state present --type __package_apt -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__package_apt/man.rst b/cdist/conf/type/__package_apt/man.rst index 39eb550b..a841fc5b 100644 --- a/cdist/conf/type/__package_apt/man.rst +++ b/cdist/conf/type/__package_apt/man.rst @@ -46,10 +46,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_emerge/man.rst b/cdist/conf/type/__package_emerge/man.rst index 24f3546d..ceb0f169 100644 --- a/cdist/conf/type/__package_emerge/man.rst +++ b/cdist/conf/type/__package_emerge/man.rst @@ -47,11 +47,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_, -`cdist-type__package_emerge_dependencies(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7), :manpage:`cdist-type__package_emerge_dependencies`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_emerge_dependencies/man.rst b/cdist/conf/type/__package_emerge_dependencies/man.rst index b07d2284..1a227853 100644 --- a/cdist/conf/type/__package_emerge_dependencies/man.rst +++ b/cdist/conf/type/__package_emerge_dependencies/man.rst @@ -36,11 +36,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_, -`cdist-type__package_emerge(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7), :manpage:`cdist-type__package_emerge`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_luarocks/man.rst b/cdist/conf/type/__package_luarocks/man.rst index e5279513..399b07af 100644 --- a/cdist/conf/type/__package_luarocks/man.rst +++ b/cdist/conf/type/__package_luarocks/man.rst @@ -39,10 +39,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_opkg/man.rst b/cdist/conf/type/__package_opkg/man.rst index 9ad4d99f..203b8a36 100644 --- a/cdist/conf/type/__package_opkg/man.rst +++ b/cdist/conf/type/__package_opkg/man.rst @@ -39,10 +39,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_pacman/man.rst b/cdist/conf/type/__package_pacman/man.rst index b144422b..44f36255 100644 --- a/cdist/conf/type/__package_pacman/man.rst +++ b/cdist/conf/type/__package_pacman/man.rst @@ -42,10 +42,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_pip/man.rst b/cdist/conf/type/__package_pip/man.rst index 026562c1..f1ba98d9 100644 --- a/cdist/conf/type/__package_pip/man.rst +++ b/cdist/conf/type/__package_pip/man.rst @@ -49,10 +49,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_pkg_freebsd/man.rst b/cdist/conf/type/__package_pkg_freebsd/man.rst index 8249c8f5..a2633bcb 100644 --- a/cdist/conf/type/__package_pkg_freebsd/man.rst +++ b/cdist/conf/type/__package_pkg_freebsd/man.rst @@ -54,10 +54,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_pkg_openbsd/man.rst b/cdist/conf/type/__package_pkg_openbsd/man.rst index 9d253dce..e776956c 100644 --- a/cdist/conf/type/__package_pkg_openbsd/man.rst +++ b/cdist/conf/type/__package_pkg_openbsd/man.rst @@ -54,10 +54,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_pkgng_freebsd/man.rst b/cdist/conf/type/__package_pkgng_freebsd/man.rst index 83fbf7bf..9fdd7c76 100644 --- a/cdist/conf/type/__package_pkgng_freebsd/man.rst +++ b/cdist/conf/type/__package_pkgng_freebsd/man.rst @@ -85,10 +85,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_rubygem/man.rst b/cdist/conf/type/__package_rubygem/man.rst index 0822bcf2..eb76a036 100644 --- a/cdist/conf/type/__package_rubygem/man.rst +++ b/cdist/conf/type/__package_rubygem/man.rst @@ -39,10 +39,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_update_index/man.rst b/cdist/conf/type/__package_update_index/man.rst index a8f16d21..e64fddae 100644 --- a/cdist/conf/type/__package_update_index/man.rst +++ b/cdist/conf/type/__package_update_index/man.rst @@ -40,12 +40,6 @@ EXAMPLES __package_update_index --type apt -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Ricardo Catalinas Jiménez diff --git a/cdist/conf/type/__package_upgrade_all/man.rst b/cdist/conf/type/__package_upgrade_all/man.rst index f6b216b4..fd4dba44 100644 --- a/cdist/conf/type/__package_upgrade_all/man.rst +++ b/cdist/conf/type/__package_upgrade_all/man.rst @@ -40,12 +40,6 @@ EXAMPLES __package_upgrade_all --type apt -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Ricardo Catalinas Jiménez diff --git a/cdist/conf/type/__package_yum/man.rst b/cdist/conf/type/__package_yum/man.rst index 487150b9..544afbf2 100644 --- a/cdist/conf/type/__package_yum/man.rst +++ b/cdist/conf/type/__package_yum/man.rst @@ -49,10 +49,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_zypper/man.rst b/cdist/conf/type/__package_zypper/man.rst index 754b5ddd..da8d1d81 100644 --- a/cdist/conf/type/__package_zypper/man.rst +++ b/cdist/conf/type/__package_zypper/man.rst @@ -56,10 +56,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__package(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__pacman_conf/man.rst b/cdist/conf/type/__pacman_conf/man.rst index c0040664..a61f2498 100644 --- a/cdist/conf/type/__pacman_conf/man.rst +++ b/cdist/conf/type/__pacman_conf/man.rst @@ -59,10 +59,7 @@ EXAMPLES SEE ALSO -------- -grep(1) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`grep`\ (1) AUTHORS diff --git a/cdist/conf/type/__pacman_conf_integrate/man.rst b/cdist/conf/type/__pacman_conf_integrate/man.rst index 10ff0c8a..77d5c1c3 100644 --- a/cdist/conf/type/__pacman_conf_integrate/man.rst +++ b/cdist/conf/type/__pacman_conf_integrate/man.rst @@ -35,10 +35,7 @@ EXAMPLES SEE ALSO -------- -grep(1) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`grep`\ (1) AUTHORS diff --git a/cdist/conf/type/__pf_apply/man.rst b/cdist/conf/type/__pf_apply/man.rst index 20374699..2c7fd4fb 100644 --- a/cdist/conf/type/__pf_apply/man.rst +++ b/cdist/conf/type/__pf_apply/man.rst @@ -39,11 +39,7 @@ EXAMPLES SEE ALSO -------- -pf(4), -`cdist-type__pf_ruleset(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`pf`\ (4), :manpage:`cdist-type__pf_ruleset`\ (7) AUTHORS diff --git a/cdist/conf/type/__pf_ruleset/man.rst b/cdist/conf/type/__pf_ruleset/man.rst index 15d50408..eb97e086 100644 --- a/cdist/conf/type/__pf_ruleset/man.rst +++ b/cdist/conf/type/__pf_ruleset/man.rst @@ -39,10 +39,7 @@ EXAMPLES SEE ALSO -------- -pf(4) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`pf`\ (4) AUTHORS diff --git a/cdist/conf/type/__postfix/man.rst b/cdist/conf/type/__postfix/man.rst index 628356b2..dff85fec 100644 --- a/cdist/conf/type/__postfix/man.rst +++ b/cdist/conf/type/__postfix/man.rst @@ -29,12 +29,6 @@ EXAMPLES __postfix -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__postfix_master/man.rst b/cdist/conf/type/__postfix_master/man.rst index 7f100485..27078070 100644 --- a/cdist/conf/type/__postfix_master/man.rst +++ b/cdist/conf/type/__postfix_master/man.rst @@ -68,10 +68,7 @@ EXAMPLES SEE ALSO -------- -master(5) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`master`\ (5) AUTHORS diff --git a/cdist/conf/type/__postfix_postconf/man.rst b/cdist/conf/type/__postfix_postconf/man.rst index f1a4b0a6..5773fcaf 100644 --- a/cdist/conf/type/__postfix_postconf/man.rst +++ b/cdist/conf/type/__postfix_postconf/man.rst @@ -38,10 +38,7 @@ EXAMPLES SEE ALSO -------- -postconf(5) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`postconf`\ (5) AUTHORS diff --git a/cdist/conf/type/__postfix_postmap/man.rst b/cdist/conf/type/__postfix_postmap/man.rst index 20aeb2df..2f455346 100644 --- a/cdist/conf/type/__postfix_postmap/man.rst +++ b/cdist/conf/type/__postfix_postmap/man.rst @@ -29,12 +29,6 @@ EXAMPLES __postfix_postmap /etc/postfix/generic -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__postfix_reload/man.rst b/cdist/conf/type/__postfix_reload/man.rst index ec9529e9..36a66d45 100644 --- a/cdist/conf/type/__postfix_reload/man.rst +++ b/cdist/conf/type/__postfix_reload/man.rst @@ -29,12 +29,6 @@ EXAMPLES __postfix_reload -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__postgres_database/man.rst b/cdist/conf/type/__postgres_database/man.rst index 2a0ad8d0..69e1a67f 100644 --- a/cdist/conf/type/__postgres_database/man.rst +++ b/cdist/conf/type/__postgres_database/man.rst @@ -30,10 +30,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__postgres_role(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__postgres_role`\ (7) AUTHORS diff --git a/cdist/conf/type/__postgres_role/man.rst b/cdist/conf/type/__postgres_role/man.rst index 9d0b68ab..f9293be5 100644 --- a/cdist/conf/type/__postgres_role/man.rst +++ b/cdist/conf/type/__postgres_role/man.rst @@ -48,10 +48,8 @@ EXAMPLES SEE ALSO -------- -`cdist-type__postgres_database(7) `_ +:manpage:`cdist-type__postgres_database`\ (7) -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. postgresql documentation at: . diff --git a/cdist/conf/type/__process/man.rst b/cdist/conf/type/__process/man.rst index 076377e1..19f68ddc 100644 --- a/cdist/conf/type/__process/man.rst +++ b/cdist/conf/type/__process/man.rst @@ -58,10 +58,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__start_on_boot(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__start_on_boot`\ (7) AUTHORS diff --git a/cdist/conf/type/__pyvenv/man.rst b/cdist/conf/type/__pyvenv/man.rst index f43454a7..977501e6 100644 --- a/cdist/conf/type/__pyvenv/man.rst +++ b/cdist/conf/type/__pyvenv/man.rst @@ -67,12 +67,6 @@ EXAMPLES __pyvenv /home/services/djangoenv --venvparams "--copies --system-site-packages" -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Darko Poljak diff --git a/cdist/conf/type/__qemu_img/man.rst b/cdist/conf/type/__qemu_img/man.rst index 3a137f4b..7cb4a758 100644 --- a/cdist/conf/type/__qemu_img/man.rst +++ b/cdist/conf/type/__qemu_img/man.rst @@ -37,10 +37,7 @@ EXAMPLES SEE ALSO -------- -qemu-img(1) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`qemu-img`\ (1) AUTHORS diff --git a/cdist/conf/type/__rbenv/man.rst b/cdist/conf/type/__rbenv/man.rst index fe965796..6341908a 100644 --- a/cdist/conf/type/__rbenv/man.rst +++ b/cdist/conf/type/__rbenv/man.rst @@ -36,12 +36,6 @@ EXAMPLES __rbenv /home/bastian --state absent -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Nico Schottelius diff --git a/cdist/conf/type/__rsync/man.rst b/cdist/conf/type/__rsync/man.rst index bac144c2..28e85ab2 100644 --- a/cdist/conf/type/__rsync/man.rst +++ b/cdist/conf/type/__rsync/man.rst @@ -98,10 +98,7 @@ EXAMPLES SEE ALSO -------- -rsync(1) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`rsync`\ (1) AUTHORS diff --git a/cdist/conf/type/__rvm/man.rst b/cdist/conf/type/__rvm/man.rst index bf84328c..412b651d 100644 --- a/cdist/conf/type/__rvm/man.rst +++ b/cdist/conf/type/__rvm/man.rst @@ -31,12 +31,8 @@ EXAMPLES SEE ALSO -------- -`cdist-type__rvm_gem(7) `_, -`cdist-type__rvm_gemset(7) `_, -`cdist-type__rvm_ruby(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__rvm_gem`\ (7), :manpage:`cdist-type__rvm_gemset`\ (7), +:manpage:`cdist-type__rvm_ruby`\ (7) AUTHORS diff --git a/cdist/conf/type/__rvm_gem/man.rst b/cdist/conf/type/__rvm_gem/man.rst index 5e65a712..a60fe843 100644 --- a/cdist/conf/type/__rvm_gem/man.rst +++ b/cdist/conf/type/__rvm_gem/man.rst @@ -43,12 +43,8 @@ EXAMPLES SEE ALSO -------- -`cdist-type__rvm(7) `_, -`cdist-type__rvm_gemset(7) `_, -`cdist-type__rvm_ruby(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__rvm`\ (7), :manpage:`cdist-type__rvm_gemset`\ (7), +:manpage:`cdist-type__rvm_ruby`\ (7) AUTHORS diff --git a/cdist/conf/type/__rvm_gemset/man.rst b/cdist/conf/type/__rvm_gemset/man.rst index 0d04ed94..4259ec92 100644 --- a/cdist/conf/type/__rvm_gemset/man.rst +++ b/cdist/conf/type/__rvm_gemset/man.rst @@ -41,12 +41,8 @@ EXAMPLES SEE ALSO -------- -`cdist-type__rvm(7) `_, -`cdist-type__rvm_gem(7) `_, -`cdist-type__rvm_ruby(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__rvm`\ (7), :manpage:`cdist-type__rvm_gem`\ (7), +:manpage:`cdist-type__rvm_ruby`\ (7) AUTHORS diff --git a/cdist/conf/type/__rvm_ruby/man.rst b/cdist/conf/type/__rvm_ruby/man.rst index d2bd4d08..18b6044b 100644 --- a/cdist/conf/type/__rvm_ruby/man.rst +++ b/cdist/conf/type/__rvm_ruby/man.rst @@ -42,12 +42,8 @@ EXAMPLES SEE ALSO -------- -`cdist-type__rvm(7) `_, -`cdist-type__rvm_gem(7) `_, -`cdist-type__rvm_gemset(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__rvm`\ (7), :manpage:`cdist-type__rvm_gem`\ (7), +:manpage:`cdist-type__rvm_gemset`\ (7) AUTHORS diff --git a/cdist/conf/type/__ssh_authorized_key/man.rst b/cdist/conf/type/__ssh_authorized_key/man.rst index a2f90574..3585717f 100644 --- a/cdist/conf/type/__ssh_authorized_key/man.rst +++ b/cdist/conf/type/__ssh_authorized_key/man.rst @@ -55,11 +55,8 @@ EXAMPLES SEE ALSO -------- -`cdist__ssh_authorized_keys(7) `_, -sshd(8) +:manpage:`cdist__ssh_authorized_keys`\ (7), :manpage:`sshd`\ (8) -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. AUTHORS ------- diff --git a/cdist/conf/type/__ssh_authorized_keys/man.rst b/cdist/conf/type/__ssh_authorized_keys/man.rst index cab844cc..6729660e 100644 --- a/cdist/conf/type/__ssh_authorized_keys/man.rst +++ b/cdist/conf/type/__ssh_authorized_keys/man.rst @@ -105,10 +105,7 @@ EXAMPLES SEE ALSO -------- -sshd(8) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`sshd`\ (8) AUTHORS diff --git a/cdist/conf/type/__ssh_dot_ssh/man.rst b/cdist/conf/type/__ssh_dot_ssh/man.rst index 6d449a4c..75adbde0 100644 --- a/cdist/conf/type/__ssh_dot_ssh/man.rst +++ b/cdist/conf/type/__ssh_dot_ssh/man.rst @@ -33,10 +33,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__ssh_authorized_keys(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__ssh_authorized_keys`\ (7) AUTHORS diff --git a/cdist/conf/type/__staged_file/man.rst b/cdist/conf/type/__staged_file/man.rst index 69ea3678..d11338af 100644 --- a/cdist/conf/type/__staged_file/man.rst +++ b/cdist/conf/type/__staged_file/man.rst @@ -99,10 +99,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__file(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__file`\ (7) AUTHORS diff --git a/cdist/conf/type/__start_on_boot/man.rst b/cdist/conf/type/__start_on_boot/man.rst index 7d009bf0..70c3e8d4 100644 --- a/cdist/conf/type/__start_on_boot/man.rst +++ b/cdist/conf/type/__start_on_boot/man.rst @@ -45,10 +45,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__process(7) `_ - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__process`\ (7) AUTHORS diff --git a/cdist/conf/type/__timezone/man.rst b/cdist/conf/type/__timezone/man.rst index 6e18c759..8a945c16 100644 --- a/cdist/conf/type/__timezone/man.rst +++ b/cdist/conf/type/__timezone/man.rst @@ -34,12 +34,6 @@ EXAMPLES __timezone US/Central -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Ramon Salvadó diff --git a/cdist/conf/type/__update_alternatives/man.rst b/cdist/conf/type/__update_alternatives/man.rst index bcedc1bf..c2b8bf6d 100644 --- a/cdist/conf/type/__update_alternatives/man.rst +++ b/cdist/conf/type/__update_alternatives/man.rst @@ -30,11 +30,7 @@ EXAMPLES SEE ALSO -------- -`cdist-type__debconf_set_selections(7) `_, -update-alternatives(8) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`cdist-type__debconf_set_selections`\ (7), :manpage:`update-alternatives`\ (8) AUTHORS diff --git a/cdist/conf/type/__user/man.rst b/cdist/conf/type/__user/man.rst index 0dd91ddd..1ad17b5b 100644 --- a/cdist/conf/type/__user/man.rst +++ b/cdist/conf/type/__user/man.rst @@ -84,10 +84,7 @@ EXAMPLES SEE ALSO -------- -pw(8), usermod(8) - -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. +:manpage:`pw`\ (8), :manpage:`usermod`\ (8) AUTHORS diff --git a/cdist/conf/type/__user_groups/man.rst b/cdist/conf/type/__user_groups/man.rst index 216a31c8..37fd25d7 100644 --- a/cdist/conf/type/__user_groups/man.rst +++ b/cdist/conf/type/__user_groups/man.rst @@ -39,12 +39,6 @@ EXAMPLES --group webuser2 --state absent -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__yum_repo/man.rst b/cdist/conf/type/__yum_repo/man.rst index b3866739..543a456d 100644 --- a/cdist/conf/type/__yum_repo/man.rst +++ b/cdist/conf/type/__yum_repo/man.rst @@ -111,12 +111,6 @@ EXAMPLES --gpgkey https://fedoraproject.org/static/0608B895.txt -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Steven Armstrong diff --git a/cdist/conf/type/__zypper_repo/man.rst b/cdist/conf/type/__zypper_repo/man.rst index bcf376de..9cc5e1c3 100644 --- a/cdist/conf/type/__zypper_repo/man.rst +++ b/cdist/conf/type/__zypper_repo/man.rst @@ -60,12 +60,6 @@ EXAMPLES __zypper_repo testrepo4 --state disabled --repo_id 4 -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Daniel Heule diff --git a/cdist/conf/type/__zypper_service/man.rst b/cdist/conf/type/__zypper_service/man.rst index f586742a..c596dea0 100644 --- a/cdist/conf/type/__zypper_service/man.rst +++ b/cdist/conf/type/__zypper_service/man.rst @@ -53,12 +53,6 @@ EXAMPLES __zypper_service INTERNAL_SLES11_SP3 --state absent --uri "http://path/to/your/ris/dir" -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>, -especially cdist type chapter: <:cdist_docs:`cdist-type`>. - - AUTHORS ------- Daniel Heule diff --git a/docs/man/Makefile b/docs/man/Makefile index 2bab13ce..bec5d97f 100644 --- a/docs/man/Makefile +++ b/docs/man/Makefile @@ -5,7 +5,9 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = -BUILDDIR = _build +BUILDDIR = ../dist +# for cache, etc. +_BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) @@ -15,7 +17,7 @@ endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +ALLSPHINXOPTS = -d $(_BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . @@ -52,6 +54,7 @@ help: .PHONY: clean clean: rm -rf $(BUILDDIR)/* + rm -rf $(_BUILDDIR)/* .PHONY: html html: diff --git a/docs/man/cdist-install.rst b/docs/man/cdist-install.rst index 7e8bba7a..f950a1ee 100644 --- a/docs/man/cdist-install.rst +++ b/docs/man/cdist-install.rst @@ -76,9 +76,9 @@ If you want to build and use the manpages, run: .. code-block:: sh make man - export MANPATH=$MANPATH:$(pwd -P)/docs/man/_build/man + export MANPATH=$MANPATH:$(pwd -P)/docs/dist/man -Or you can move manpages from docs/man/_build/man directory to some +Or you can move manpages from docs/dist/man directory to some other directory and add it to MANPATH. You can also build manpages for types in your ~/.cdist directory: @@ -87,12 +87,23 @@ You can also build manpages for types in your ~/.cdist directory: make dotman -Built manpages are now in docs/man/_build/man directory. If you have -some other custom .cdist directory, e.g. /custom/.cdist then use: +Built manpages are now in docs/dist/man directory. If you have +some other custom .cdist directory, e.g. /opt/cdist then use: .. code-block:: sh - DOT_CDIST_PATH=/custom/.cdist make dotman + DOT_CDIST_PATH=/opt/cdist make dotman + +Building and using HTML documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you want to build and use HTML documentation, run: + +.. code-block:: sh + + make html + +Now you can access docs/dist/html/index.html. Python package ~~~~~~~~~~~~~~ diff --git a/docs/man/conf.py b/docs/man/conf.py index 916b06a4..334cfd51 100644 --- a/docs/man/conf.py +++ b/docs/man/conf.py @@ -310,9 +310,3 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False - -extlinks = { - 'cdist_docs': - ('http://www.nico.schottelius.org/software/cdist/man/{}/%s.html'.format( - release), None), -} diff --git a/docs/man/man1/cdist.rst b/docs/man/man1/cdist.rst index 2a056482..efc1a201 100644 --- a/docs/man/man1/cdist.rst +++ b/docs/man/man1/cdist.rst @@ -175,10 +175,6 @@ The following exit values shall be returned: One or more host configurations failed -SEE ALSO --------- -Full documentation at: <:cdist_docs:`index`>. - AUTHORS ------- Nico Schottelius From 7d3c66859cd3fe8ac6d4e6a3ce4c5a110e22ea93 Mon Sep 17 00:00:00 2001 From: Darko Poljak Date: Thu, 30 Jun 2016 12:18:42 +0200 Subject: [PATCH 2/2] Separate man pages by section number. --- docs/man/Makefile | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/man/Makefile b/docs/man/Makefile index bec5d97f..800a80d8 100644 --- a/docs/man/Makefile +++ b/docs/man/Makefile @@ -165,6 +165,10 @@ text: .PHONY: man man: $(SPHINXBUILD) -b cman $(ALLSPHINXOPTS) $(BUILDDIR)/man + mkdir -p $(BUILDDIR)/man/man1 + mkdir -p $(BUILDDIR)/man/man7 + mv -f $(BUILDDIR)/man/*.1 $(BUILDDIR)/man/man1/ + mv -f $(BUILDDIR)/man/*.7 $(BUILDDIR)/man/man7/ @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man."