fancsali/cdist-backup
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #451 from darko-poljak/manpages-fix

Browse source 
Make man pages SEE ALSO by convention. Improve docs building.
This commit is contained in:
Darko Poljak 2016-06-30 12:19:06 +02:00 committed by GitHub
commit 2981fc20da
100 changed files with 98 additions and 485 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.gitignore vendored
View file

@ -20,8 +20,9 @@ MANIFEST
dist/ dist/
cdist/version.py cdist/version.py
#sphinx build dir # sphinx build dirs, cache
_build/ _build/
docs/dist
# Packaging: Archlinux # Packaging: Archlinux
/PKGBUILD /PKGBUILD

6
cdist/conf/type/__apt_key/man.rst
View file

@ -48,12 +48,6 @@ EXAMPLES
__apt_key UbuntuArchiveKey --keyid 437D05B5 --keyserver keyserver.ubuntu.com __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 AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__apt_key_uri/man.rst
View file

@ -38,12 +38,6 @@ EXAMPLES
--state present --state present
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__apt_norecommends/man.rst
View file

@ -29,12 +29,6 @@ EXAMPLES
__apt_norecommends __apt_norecommends
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__apt_ppa/man.rst
View file

@ -37,12 +37,6 @@ EXAMPLES
__apt_ppa ppa:sans-intern/missing-bits --state absent __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 AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__apt_source/man.rst
View file

@ -56,12 +56,6 @@ EXAMPLES
--component partner --state present --component partner --state present
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__apt_update_index/man.rst
View file

@ -28,12 +28,6 @@ EXAMPLES
__apt_update_index __apt_update_index
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__block/man.rst
View file

@ -69,12 +69,6 @@ EXAMPLES
DONE DONE
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

7
cdist/conf/type/__ccollect_source/man.rst
View file

@ -53,12 +53,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
ccollect(1) :manpage:`ccollect`\ (1)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
ccollect documentation at:
<http://www.nico.schottelius.org/software/ccollect/>.
AUTHORS AUTHORS

6
cdist/conf/type/__cdist/man.rst
View file

@ -50,12 +50,6 @@ EXAMPLES
__cdist --source "git://git.schottelius.org/cdist" /home/cdist/cdist __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 AUTHORS
------- -------
Nico Schottelius <nico-cdist--@--schottelius.org> Nico Schottelius <nico-cdist--@--schottelius.org>

6
cdist/conf/type/__cdistmarker/man.rst
View file

@ -42,12 +42,6 @@ EXAMPLES
__cdistmarker --destination /tmp/cdist_marker --format '+%s' __cdistmarker --destination /tmp/cdist_marker --format '+%s'
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Daniel Maher <phrawzty+cdist--@--gmail.com> Daniel Maher <phrawzty+cdist--@--gmail.com>

5
cdist/conf/type/__config_file/man.rst
View file

@ -48,10 +48,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__file(7) <cdist-type__file.html>`_ :manpage:`cdist-type__file`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__consul/man.rst
View file

@ -41,12 +41,6 @@ EXAMPLES
--version 0.4.1 --version 0.4.1
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

5
cdist/conf/type/__consul_agent/man.rst
View file

@ -165,10 +165,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
Full documentation at: <:cdist_docs:`index`>, consul documentation at: <http://www.consul.io/docs/agent/options.html>.
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
consul documentation at:
<http://www.consul.io/docs/agent/options.html>.
AUTHORS AUTHORS

5
cdist/conf/type/__consul_check/man.rst
View file

@ -62,10 +62,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_ :manpage:`cdist-type__consul_agent`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__consul_reload/man.rst
View file

@ -29,12 +29,6 @@ EXAMPLES
__consul_reload __consul_reload
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

5
cdist/conf/type/__consul_service/man.rst
View file

@ -66,10 +66,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_ :manpage:`cdist-type__consul_agent`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__consul_template/man.rst
View file

@ -125,10 +125,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
Full documentation at: <:cdist_docs:`index`>, consul documentation at: <https://github.com/hashicorp/consul-template>.
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
consul documentation at:
<https://github.com/hashicorp/consul-template>.
AUTHORS AUTHORS

6
cdist/conf/type/__consul_template_template/man.rst
View file

@ -59,11 +59,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__consul_template(7) <cdist-type__consul_template.html>`_, :manpage:`cdist-type__consul_template`\ (7), :manpage:`cdist-type__consul_template_config`\ (7)
`cdist-type__consul_template_config(7) <cdist-type__consul_template_config.html>`_
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

7
cdist/conf/type/__consul_watch_checks/man.rst
View file

@ -55,12 +55,9 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_ :manpage:`cdist-type__consul_agent`\ (7)
Full documentation at: <:cdist_docs:`index`>, consul documentation at: <http://www.consul.io/docs/agent/watches.html>.
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
consul documentation at:
<http://www.consul.io/docs/agent/watches.html>.
AUTHORS AUTHORS

7
cdist/conf/type/__consul_watch_event/man.rst
View file

@ -48,12 +48,9 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_ :manpage:`cdist-type__consul_agent`\ (7)
Full documentation at: <:cdist_docs:`index`>, consul documentation at: <http://www.consul.io/docs/agent/watches.html>.
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
consul documentation at:
<http://www.consul.io/docs/agent/watches.html>.
AUTHORS AUTHORS

7
cdist/conf/type/__consul_watch_key/man.rst
View file

@ -45,12 +45,9 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_ :manpage:`cdist-type__consul_agent`\ (7)
Full documentation at: <:cdist_docs:`index`>, consul documentation at: <http://www.consul.io/docs/agent/watches.html>.
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
consul documentation at:
<http://www.consul.io/docs/agent/watches.html>.
AUTHORS AUTHORS

6
cdist/conf/type/__consul_watch_keyprefix/man.rst
View file

@ -45,11 +45,9 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_ :manpage:`cdist-type__consul_agent`\ (7)
Full documentation at: <:cdist_docs:`index`>, consul documentation at: <http://www.consul.io/docs/agent/watches.html>.
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
consule documentation at: <http://www.consul.io/docs/agent/watches.html>.
AUTHORS AUTHORS

7
cdist/conf/type/__consul_watch_nodes/man.rst
View file

@ -41,12 +41,9 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_ :manpage:`cdist-type__consul_agent`\ (7)
Full documentation at: <:cdist_docs:`index`>, consul documentation at: <http://www.consul.io/docs/agent/watches.html>.
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
consul documentation at:
<http://www.consul.io/docs/agent/watches.html>.
AUTHORS AUTHORS

6
cdist/conf/type/__consul_watch_service/man.rst
View file

@ -65,11 +65,9 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_ :manpage:`cdist-type__consul_agent`\ (7)
Full documentation at: <:cdist_docs:`index`>, consul documentation at: <http://www.consul.io/docs/agent/watches.html>.
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
consule documentation at: <http://www.consul.io/docs/agent/watches.html>.
AUTHORS AUTHORS

7
cdist/conf/type/__consul_watch_services/man.rst
View file

@ -41,12 +41,9 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__consul_agent(7) <cdist-type__consul_agent.html>`_ :manpage:`cdist-type__consul_agent`\ (7)
Full documentation at: <:cdist_docs:`index`>, consul documentation at: <http://www.consul.io/docs/agent/watches.html>.
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
consul documentation at:
<http://www.consul.io/docs/agent/watches.html>.
AUTHORS AUTHORS

5
cdist/conf/type/__cron/man.rst
View file

@ -68,10 +68,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
crontab(5) :manpage:`crontab`\ (5)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__debconf_set_selections/man.rst
View file

@ -37,11 +37,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
debconf-set-selections(1), :manpage:`debconf-set-selections`\ (1), :manpage:`cdist-type__update_alternatives`\ (7)
`cdist-type__update_alternatives(7) <cdist-type__update_alternatives.html>`_
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__directory/man.rst
View file

@ -88,12 +88,6 @@ EXAMPLES
--owner root --group root --mode 0755 --state present --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 AUTHORS
------- -------
Nico Schottelius <nico-cdist--@--schottelius.org> Nico Schottelius <nico-cdist--@--schottelius.org>

5
cdist/conf/type/__dog_vdi/man.rst
View file

@ -43,10 +43,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
qemu(1), dog(8) :manpage:`qemu`\ (1), :manpage:`dog`\ (8)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__file/man.rst
View file

@ -99,12 +99,6 @@ EXAMPLES
DONE DONE
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Nico Schottelius <nico-cdist--@--schottelius.org> Nico Schottelius <nico-cdist--@--schottelius.org>

6
cdist/conf/type/__firewalld_rule/man.rst
View file

@ -65,11 +65,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__iptables_rule(7) <cdist-type__iptables_rule.html>`_, :manpage:`cdist-type__iptables_rule`\ (7), :manpage:`firewalld`\ (8)
firewalld(8)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__git/man.rst
View file

@ -47,12 +47,6 @@ EXAMPLES
__git /home/nico/cdist --source git://github.com/telmich/cdist.git --branch 2.1 __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 AUTHORS
------- -------
Nico Schottelius <nico-cdist--@--schottelius.org> Nico Schottelius <nico-cdist--@--schottelius.org>

6
cdist/conf/type/__group/man.rst
View file

@ -67,12 +67,6 @@ EXAMPLES
__group foobar --gid 1234 --password 'crypted-password-string' __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 AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__hostname/man.rst
View file

@ -39,12 +39,6 @@ EXAMPLES
__hostname --name some-static-hostname __hostname --name some-static-hostname
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__iptables_apply/man.rst
View file

@ -29,11 +29,7 @@ None (__iptables_apply is used by __iptables_rule)
SEE ALSO SEE ALSO
-------- --------
`cdist-type__iptables_rule(7) <cdist-type__iptables_rule.html>`_, :manpage:`cdist-type__iptables_rule`\ (7), :manpage:`iptables`\ (8)
iptables(8)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__iptables_rule/man.rst
View file

@ -50,11 +50,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__iptables_apply(7) <cdist-type__iptables_apply.html>`_, :manpage:`cdist-type__iptables_apply`\ (7), :manpage:`iptables`\ (8)
iptables(8)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__issue/man.rst
View file

@ -34,12 +34,6 @@ EXAMPLES
__issue --source "$__type/files/myfancyissue" __issue --source "$__type/files/myfancyissue"
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Nico Schottelius <nico-cdist--@--schottelius.org> Nico Schottelius <nico-cdist--@--schottelius.org>

3
cdist/conf/type/__jail/man.rst
View file

@ -108,8 +108,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
Full documentation at: <:cdist_docs:`index`>, :manpage:`jail`\ (8)
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

3
cdist/conf/type/__jail_freebsd10/man.rst
View file

@ -107,8 +107,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
Full documentation at: <:cdist_docs:`index`>, :manpage:`jail`\ (8)
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

3
cdist/conf/type/__jail_freebsd9/man.rst
View file

@ -108,8 +108,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
Full documentation at: <:cdist_docs:`index`>, :manpage:`jail`\ (8)
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__key_value/man.rst
View file

@ -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. 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 AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

5
cdist/conf/type/__line/man.rst
View file

@ -61,10 +61,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
grep(1) :manpage:`grep`\ (1)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__link/man.rst
View file

@ -47,12 +47,6 @@ EXAMPLES
__link /opt/plone --state absent __link /opt/plone --state absent
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Nico Schottelius <nico-cdist--@--schottelius.org> Nico Schottelius <nico-cdist--@--schottelius.org>

5
cdist/conf/type/__locale/man.rst
View file

@ -34,10 +34,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
locale(1), localedef(1) :manpage:`locale`\ (1), :manpage:`localedef`\ (1)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__motd/man.rst
View file

@ -35,12 +35,6 @@ EXAMPLES
__motd --source "$__type/files/my-motd" __motd --source "$__type/files/my-motd"
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Nico Schottelius <nico-cdist--@--schottelius.org> Nico Schottelius <nico-cdist--@--schottelius.org>

6
cdist/conf/type/__mount/man.rst
View file

@ -71,12 +71,6 @@ EXAMPLES
--options "mfsmaster=mfsmaster.domain.tld,mfssubfolder=/one,nonempty,_netdev" --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 AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__mysql_database/man.rst
View file

@ -36,12 +36,6 @@ EXAMPLES
__mysql_database "cdist" --name "cdist" --user "myuser" --password "mypwd" __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 AUTHORS
------- -------
Benedikt Koeppel <code@benediktkoeppel.ch> Benedikt Koeppel <code@benediktkoeppel.ch>

6
cdist/conf/type/__package/man.rst
View file

@ -51,12 +51,6 @@ EXAMPLES
__package vim --state present --type __package_apt __package vim --state present --type __package_apt
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

5
cdist/conf/type/__package_apt/man.rst
View file

@ -46,10 +46,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_ :manpage:`cdist-type__package`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__package_emerge/man.rst
View file

@ -47,11 +47,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_, :manpage:`cdist-type__package`\ (7), :manpage:`cdist-type__package_emerge_dependencies`\ (7)
`cdist-type__package_emerge_dependencies(7) <cdist-type__package_emerge_dependencies.html>`_
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__package_emerge_dependencies/man.rst
View file

@ -36,11 +36,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_, :manpage:`cdist-type__package`\ (7), :manpage:`cdist-type__package_emerge`\ (7)
`cdist-type__package_emerge(7) <cdist-type__package_emerge.html>`_
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__package_luarocks/man.rst
View file

@ -39,10 +39,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_ :manpage:`cdist-type__package`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__package_opkg/man.rst
View file

@ -39,10 +39,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_ :manpage:`cdist-type__package`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__package_pacman/man.rst
View file

@ -42,10 +42,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_ :manpage:`cdist-type__package`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__package_pip/man.rst
View file

@ -49,10 +49,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_ :manpage:`cdist-type__package`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__package_pkg_freebsd/man.rst
View file

@ -54,10 +54,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_ :manpage:`cdist-type__package`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__package_pkg_openbsd/man.rst
View file

@ -54,10 +54,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_ :manpage:`cdist-type__package`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__package_pkgng_freebsd/man.rst
View file

@ -85,10 +85,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_ :manpage:`cdist-type__package`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__package_rubygem/man.rst
View file

@ -39,10 +39,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_ :manpage:`cdist-type__package`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__package_update_index/man.rst
View file

@ -40,12 +40,6 @@ EXAMPLES
__package_update_index --type apt __package_update_index --type apt
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Ricardo Catalinas Jiménez <jimenezrick--@--gmail.com> Ricardo Catalinas Jiménez <jimenezrick--@--gmail.com>

6
cdist/conf/type/__package_upgrade_all/man.rst
View file

@ -40,12 +40,6 @@ EXAMPLES
__package_upgrade_all --type apt __package_upgrade_all --type apt
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Ricardo Catalinas Jiménez <jimenezrick--@--gmail.com> Ricardo Catalinas Jiménez <jimenezrick--@--gmail.com>

5
cdist/conf/type/__package_yum/man.rst
View file

@ -49,10 +49,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_ :manpage:`cdist-type__package`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__package_zypper/man.rst
View file

@ -56,10 +56,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__package(7) <cdist-type__package.html>`_ :manpage:`cdist-type__package`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__pacman_conf/man.rst
View file

@ -59,10 +59,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
grep(1) :manpage:`grep`\ (1)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__pacman_conf_integrate/man.rst
View file

@ -35,10 +35,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
grep(1) :manpage:`grep`\ (1)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__pf_apply/man.rst
View file

@ -39,11 +39,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
pf(4), :manpage:`pf`\ (4), :manpage:`cdist-type__pf_ruleset`\ (7)
`cdist-type__pf_ruleset(7) <cdist-type__pf_ruleset.html>`_
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__pf_ruleset/man.rst
View file

@ -39,10 +39,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
pf(4) :manpage:`pf`\ (4)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__postfix/man.rst
View file

@ -29,12 +29,6 @@ EXAMPLES
__postfix __postfix
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

5
cdist/conf/type/__postfix_master/man.rst
View file

@ -68,10 +68,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
master(5) :manpage:`master`\ (5)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__postfix_postconf/man.rst
View file

@ -38,10 +38,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
postconf(5) :manpage:`postconf`\ (5)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__postfix_postmap/man.rst
View file

@ -29,12 +29,6 @@ EXAMPLES
__postfix_postmap /etc/postfix/generic __postfix_postmap /etc/postfix/generic
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__postfix_reload/man.rst
View file

@ -29,12 +29,6 @@ EXAMPLES
__postfix_reload __postfix_reload
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

5
cdist/conf/type/__postgres_database/man.rst
View file

@ -30,10 +30,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__postgres_role(7) <cdist-type__postgres_role.html>`_ :manpage:`cdist-type__postgres_role`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

4
cdist/conf/type/__postgres_role/man.rst
View file

@ -48,10 +48,8 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__postgres_database(7) <cdist-type__postgres_database.html>`_ :manpage:`cdist-type__postgres_database`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
postgresql documentation at: postgresql documentation at:
<http://www.postgresql.org/docs/current/static/sql-createrole.html>. <http://www.postgresql.org/docs/current/static/sql-createrole.html>.

5
cdist/conf/type/__process/man.rst
View file

@ -58,10 +58,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__start_on_boot(7) <cdist-type__start_on_boot.html>`_ :manpage:`cdist-type__start_on_boot`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__pyvenv/man.rst
View file

@ -67,12 +67,6 @@ EXAMPLES
__pyvenv /home/services/djangoenv --venvparams "--copies --system-site-packages" __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 AUTHORS
------- -------
Darko Poljak <darko.poljak--@--gmail.com> Darko Poljak <darko.poljak--@--gmail.com>

5
cdist/conf/type/__qemu_img/man.rst
View file

@ -37,10 +37,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
qemu-img(1) :manpage:`qemu-img`\ (1)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__rbenv/man.rst
View file

@ -36,12 +36,6 @@ EXAMPLES
__rbenv /home/bastian --state absent __rbenv /home/bastian --state absent
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Nico Schottelius <nico-cdist--@--schottelius.org> Nico Schottelius <nico-cdist--@--schottelius.org>

5
cdist/conf/type/__rsync/man.rst
View file

@ -98,10 +98,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
rsync(1) :manpage:`rsync`\ (1)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

8
cdist/conf/type/__rvm/man.rst
View file

@ -31,12 +31,8 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__rvm_gem(7) <cdist-type__rvm_gem.html>`_, :manpage:`cdist-type__rvm_gem`\ (7), :manpage:`cdist-type__rvm_gemset`\ (7),
`cdist-type__rvm_gemset(7) <cdist-type__rvm_gemset.html>`_, :manpage:`cdist-type__rvm_ruby`\ (7)
`cdist-type__rvm_ruby(7) <cdist-type__rvm_ruby.html>`_
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

8
cdist/conf/type/__rvm_gem/man.rst
View file

@ -43,12 +43,8 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__rvm(7) <cdist-type__rvm.html>`_, :manpage:`cdist-type__rvm`\ (7), :manpage:`cdist-type__rvm_gemset`\ (7),
`cdist-type__rvm_gemset(7) <cdist-type__rvm_gemset.html>`_, :manpage:`cdist-type__rvm_ruby`\ (7)
`cdist-type__rvm_ruby(7) <cdist-type__rvm_ruby.html>`_
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

8
cdist/conf/type/__rvm_gemset/man.rst
View file

@ -41,12 +41,8 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__rvm(7) <cdist-type__rvm.html>`_, :manpage:`cdist-type__rvm`\ (7), :manpage:`cdist-type__rvm_gem`\ (7),
`cdist-type__rvm_gem(7) <cdist-type__rvm_gem.html>`_, :manpage:`cdist-type__rvm_ruby`\ (7)
`cdist-type__rvm_ruby(7) <cdist-type__rvm_ruby.html>`_
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

8
cdist/conf/type/__rvm_ruby/man.rst
View file

@ -42,12 +42,8 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__rvm(7) <cdist-type__rvm.html>`_, :manpage:`cdist-type__rvm`\ (7), :manpage:`cdist-type__rvm_gem`\ (7),
`cdist-type__rvm_gem(7) <cdist-type__rvm_gem.html>`_, :manpage:`cdist-type__rvm_gemset`\ (7)
`cdist-type__rvm_gemset(7) <cdist-type__rvm_gemset.html>`_
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__ssh_authorized_key/man.rst
View file

@ -55,11 +55,8 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist__ssh_authorized_keys(7) <cdist__ssh_authorized_keys.html>`_, :manpage:`cdist__ssh_authorized_keys`\ (7), :manpage:`sshd`\ (8)
sshd(8)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------

5
cdist/conf/type/__ssh_authorized_keys/man.rst
View file

@ -105,10 +105,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
sshd(8) :manpage:`sshd`\ (8)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__ssh_dot_ssh/man.rst
View file

@ -33,10 +33,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__ssh_authorized_keys(7) <cdist-type__ssh_authorized_keys.html>`_ :manpage:`cdist-type__ssh_authorized_keys`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__staged_file/man.rst
View file

@ -99,10 +99,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__file(7) <cdist-type__file.html>`_ :manpage:`cdist-type__file`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__start_on_boot/man.rst
View file

@ -45,10 +45,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__process(7) <cdist-type__process.html>`_ :manpage:`cdist-type__process`\ (7)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__timezone/man.rst
View file

@ -34,12 +34,6 @@ EXAMPLES
__timezone US/Central __timezone US/Central
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Ramon Salvadó <rsalvado--@--gnuine--dot--com> Ramon Salvadó <rsalvado--@--gnuine--dot--com>

6
cdist/conf/type/__update_alternatives/man.rst
View file

@ -30,11 +30,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
`cdist-type__debconf_set_selections(7) <cdist-type__debconf_set_selections.html>`_, :manpage:`cdist-type__debconf_set_selections`\ (7), :manpage:`update-alternatives`\ (8)
update-alternatives(8)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

5
cdist/conf/type/__user/man.rst
View file

@ -84,10 +84,7 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
pw(8), usermod(8) :manpage:`pw`\ (8), :manpage:`usermod`\ (8)
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS

6
cdist/conf/type/__user_groups/man.rst
View file

@ -39,12 +39,6 @@ EXAMPLES
--group webuser2 --state absent --group webuser2 --state absent
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__yum_repo/man.rst
View file

@ -111,12 +111,6 @@ EXAMPLES
--gpgkey https://fedoraproject.org/static/0608B895.txt --gpgkey https://fedoraproject.org/static/0608B895.txt
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>,
especially cdist type chapter: <:cdist_docs:`cdist-type`>.
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc> Steven Armstrong <steven-cdist--@--armstrong.cc>

6
cdist/conf/type/__zypper_repo/man.rst
View file

@ -60,12 +60,6 @@ EXAMPLES
__zypper_repo testrepo4 --state disabled --repo_id 4 __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 AUTHORS
------- -------
Daniel Heule <hda--@--sfs.biz> Daniel Heule <hda--@--sfs.biz>

6
cdist/conf/type/__zypper_service/man.rst
View file

@ -53,12 +53,6 @@ EXAMPLES
__zypper_service INTERNAL_SLES11_SP3 --state absent --uri "http://path/to/your/ris/dir" __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 AUTHORS
------- -------
Daniel Heule <hda--@--sfs.biz> Daniel Heule <hda--@--sfs.biz>

11
docs/man/Makefile
View file

@ -5,7 +5,9 @@
SPHINXOPTS = SPHINXOPTS =
SPHINXBUILD = sphinx-build SPHINXBUILD = sphinx-build
PAPER = PAPER =
BUILDDIR = _build BUILDDIR = ../dist
# for cache, etc.
_BUILDDIR = _build
# User-friendly check for sphinx-build # User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
@ -15,7 +17,7 @@ endif
# Internal variables. # Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter 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 # the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
@ -52,6 +54,7 @@ help:
.PHONY: clean .PHONY: clean
clean: clean:
rm -rf $(BUILDDIR)/* rm -rf $(BUILDDIR)/*
rm -rf $(_BUILDDIR)/*
.PHONY: html .PHONY: html
html: html:
@ -162,6 +165,10 @@ text:
.PHONY: man .PHONY: man
man: man:
$(SPHINXBUILD) -b cman $(ALLSPHINXOPTS) $(BUILDDIR)/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
@echo "Build finished. The manual pages are in $(BUILDDIR)/man." @echo "Build finished. The manual pages are in $(BUILDDIR)/man."

21
docs/man/cdist-install.rst
View file

@ -76,9 +76,9 @@ If you want to build and use the manpages, run:
.. code-block:: sh .. code-block:: sh
make man 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. other directory and add it to MANPATH.
You can also build manpages for types in your ~/.cdist directory: 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 make dotman
Built manpages are now in docs/man/_build/man directory. If you have Built manpages are now in docs/dist/man directory. If you have
some other custom .cdist directory, e.g. /custom/.cdist then use: some other custom .cdist directory, e.g. /opt/cdist then use:
.. code-block:: sh .. 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 Python package
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~

6
docs/man/conf.py
View file

@ -310,9 +310,3 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
extlinks = {
'cdist_docs':
('http://www.nico.schottelius.org/software/cdist/man/{}/%s.html'.format(
release), None),
}

4
docs/man/man1/cdist.rst
View file

@ -175,10 +175,6 @@ The following exit values shall be returned:
One or more host configurations failed One or more host configurations failed
SEE ALSO
--------
Full documentation at: <:cdist_docs:`index`>.
AUTHORS AUTHORS
------- -------
Nico Schottelius <nico-cdist--@--schottelius.org> Nico Schottelius <nico-cdist--@--schottelius.org>