From 0d64d6a5b662b63dbe3d5491156699c1a1d2936a Mon Sep 17 00:00:00 2001 From: Darko Poljak Date: Thu, 30 Jun 2016 15:05:26 +0200 Subject: [PATCH 1/6] docs/man -> docs/src and update Makefile and build-helper. --- .gitignore | 13 +++---- Makefile | 38 +++++++++---------- bin/build-helper | 4 +- bin/build-helper.freebsd | 4 +- docs/{man => src}/Makefile | 0 docs/{man => src}/cdist-best-practice.rst | 0 docs/{man => src}/cdist-bootstrap.rst | 0 docs/{man => src}/cdist-explorer.rst | 0 docs/{man => src}/cdist-features.rst | 0 docs/{man => src}/cdist-hacker.rst | 0 docs/{man => src}/cdist-install.rst | 0 docs/{man => src}/cdist-intro.rst | 0 docs/{man => src}/cdist-logo.png | Bin docs/{man => src}/cdist-manifest.rst | 0 docs/{man => src}/cdist-messaging.rst | 0 docs/{man => src}/cdist-os.rst | 0 docs/{man => src}/cdist-quickstart.rst | 0 docs/{man => src}/cdist-reference.rst.sh | 0 docs/{man => src}/cdist-remote-exec-copy.rst | 0 docs/{man => src}/cdist-stages.rst | 0 docs/{man => src}/cdist-support.rst | 0 docs/{man => src}/cdist-troubleshooting.rst | 0 docs/{man => src}/cdist-type.rst | 0 docs/{man => src}/cdist-types.rst | 0 docs/{man => src}/cdist-update.rst | 0 docs/{man => src}/cdist-why.rst | 0 docs/{man => src}/conf.py | 0 docs/{man => src}/index.rst | 0 docs/{man => src}/man1/cdist.rst | 0 docs/{man => src}/man7/.gitignore | 0 30 files changed, 28 insertions(+), 31 deletions(-) rename docs/{man => src}/Makefile (100%) rename docs/{man => src}/cdist-best-practice.rst (100%) rename docs/{man => src}/cdist-bootstrap.rst (100%) rename docs/{man => src}/cdist-explorer.rst (100%) rename docs/{man => src}/cdist-features.rst (100%) rename docs/{man => src}/cdist-hacker.rst (100%) rename docs/{man => src}/cdist-install.rst (100%) rename docs/{man => src}/cdist-intro.rst (100%) rename docs/{man => src}/cdist-logo.png (100%) rename docs/{man => src}/cdist-manifest.rst (100%) rename docs/{man => src}/cdist-messaging.rst (100%) rename docs/{man => src}/cdist-os.rst (100%) rename docs/{man => src}/cdist-quickstart.rst (100%) rename docs/{man => src}/cdist-reference.rst.sh (100%) rename docs/{man => src}/cdist-remote-exec-copy.rst (100%) rename docs/{man => src}/cdist-stages.rst (100%) rename docs/{man => src}/cdist-support.rst (100%) rename docs/{man => src}/cdist-troubleshooting.rst (100%) rename docs/{man => src}/cdist-type.rst (100%) rename docs/{man => src}/cdist-types.rst (100%) rename docs/{man => src}/cdist-update.rst (100%) rename docs/{man => src}/cdist-why.rst (100%) rename docs/{man => src}/conf.py (100%) rename docs/{man => src}/index.rst (100%) rename docs/{man => src}/man1/cdist.rst (100%) rename docs/{man => src}/man7/.gitignore (100%) diff --git a/.gitignore b/.gitignore index 3bbc4e99..74014aba 100644 --- a/.gitignore +++ b/.gitignore @@ -2,14 +2,11 @@ .*.swp # Ignore generated manpages -docs/man/.marker -docs/man/man1/*.1 -docs/man/man7/*.7 -docs/man/man*/*.html -docs/man/man*/*.xml -docs/man/man*/docbook-xsl.css -docs/man/man7/cdist-type__*.rst -docs/man/cdist-reference.rst +docs/src/.marker +docs/src/man1/*.1 +docs/src/man7/*.7 +docs/src/man7/cdist-type__*.rst +docs/src/cdist-reference.rst # Ignore cdist cache for version control /cache/ diff --git a/Makefile b/Makefile index 9d494f23..7885cf24 100644 --- a/Makefile +++ b/Makefile @@ -20,7 +20,7 @@ helper=./bin/build-helper -MANDIR=docs/man +DOCS_SRC_DIR=docs/src SPEECHDIR=docs/speeches TYPEDIR=cdist/conf/type @@ -36,13 +36,13 @@ CHANGELOG_FILE=docs/changelog PYTHON_VERSION=cdist/version.py -SPHINXM=make -C $(MANDIR) man -SPHINXH=make -C $(MANDIR) html +SPHINXM=make -C $(DOCS_SRC_DIR) man +SPHINXH=make -C $(DOCS_SRC_DIR) html ################################################################################ # Manpages # -MAN1DSTDIR=$(MANDIR)/man1 -MAN7DSTDIR=$(MANDIR)/man7 +MAN1DSTDIR=$(DOCS_SRC_DIR)/man1 +MAN7DSTDIR=$(DOCS_SRC_DIR)/man7 # Manpages #1: Types # Use shell / ls to get complete list - $(TYPEDIR)/*/man.rst does not work @@ -56,26 +56,26 @@ $(MAN7DSTDIR)/cdist-type%.rst: $(TYPEDIR)/%/man.rst ln -sf "../../../$^" $@ # Manpages #2: reference -MANREF=$(MAN7DSTDIR)/cdist-reference.rst -MANREFSH=$(MANDIR)/cdist-reference.rst.sh +DOCSREF=$(MAN7DSTDIR)/cdist-reference.rst +DOCSREFSH=$(DOCS_SRC_DIR)/cdist-reference.rst.sh -$(MANREF): $(MANREFSH) - $(MANREFSH) +$(DOCSREF): $(DOCSREFSH) + $(DOCSREFSH) # Manpages #3: generic part -mansphinxman: $(MANTYPES) $(MANREF) $(PYTHON_VERSION) +sphinxman: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION) $(SPHINXM) -mansphinxhtml: $(MANTYPES) $(MANREF) $(PYTHON_VERSION) +sphinxhtml: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION) $(SPHINXH) -man: mansphinxman mansphinxhtml +docs: sphinxman sphinxhtml # Manpages #5: release part MANWEBDIR=$(WEBBASE)/man/$(CHANGELOG_VERSION) MANBUILDDIR=docs/dist/html -man-dist: man +docs-dist: man rm -rf "${MANWEBDIR}" mkdir -p "${MANWEBDIR}" # mkdir -p "${MANWEBDIR}/man1" "${MANWEBDIR}/man7" @@ -102,10 +102,10 @@ $(DOTMAN7DSTDIR)/cdist-type%.rst: $(DOTTYPEDIR)/%/man.rst ln -sf "$^" $@ # Manpages #3: generic part -dotmansphinxman: $(DOTMANTYPES) +dotsphinxman: $(DOTMANTYPES) $(SPHINXM) -dotman: dotmansphinxman +dotman: dotsphinxman ################################################################################ @@ -147,7 +147,7 @@ web-doc: web-dist: web-blog web-doc -web-pub: web-dist man-dist speeches-dist +web-pub: web-dist docs-dist speeches-dist cd "${WEBDIR}" && make pub web-release-all: man-latest-link @@ -212,12 +212,12 @@ release: # clean: - rm -f $(MANDIR)/cdist-reference.rst + rm -f $(DOCS_SRC_DIR)/cdist-reference.rst - find "$(MANDIR)" -mindepth 2 -type l \ + find "$(DOCS_SRC_DIR)" -mindepth 2 -type l \ | xargs rm -f - make -C $(MANDIR) clean + make -C $(DOCS_SRC_DIR) clean find * -name __pycache__ | xargs rm -rf diff --git a/bin/build-helper b/bin/build-helper index 31789a2e..8f228697 100755 --- a/bin/build-helper +++ b/bin/build-helper @@ -206,8 +206,8 @@ eof "$0" check-date "$0" check-unittest - # Generate man pages (indirect check if they build) - make man + # Generate documentation (man and html) + make docs # Generate speeches (indirect check if they build) make speeches diff --git a/bin/build-helper.freebsd b/bin/build-helper.freebsd index 01d86a10..02e71586 100755 --- a/bin/build-helper.freebsd +++ b/bin/build-helper.freebsd @@ -241,8 +241,8 @@ eof "$0" check-date "$0" check-unittest - # Generate man pages (indirect check if they build) - make helper=${helper} WEBDIR=${WEBDIR} man + # Generate documentation (man and html) + make helper=${helper} WEBDIR=${WEBDIR} docs # Generate speeches (indirect check if they build) make helper=${helper} WEBDIR=${WEBDIR} speeches diff --git a/docs/man/Makefile b/docs/src/Makefile similarity index 100% rename from docs/man/Makefile rename to docs/src/Makefile diff --git a/docs/man/cdist-best-practice.rst b/docs/src/cdist-best-practice.rst similarity index 100% rename from docs/man/cdist-best-practice.rst rename to docs/src/cdist-best-practice.rst diff --git a/docs/man/cdist-bootstrap.rst b/docs/src/cdist-bootstrap.rst similarity index 100% rename from docs/man/cdist-bootstrap.rst rename to docs/src/cdist-bootstrap.rst diff --git a/docs/man/cdist-explorer.rst b/docs/src/cdist-explorer.rst similarity index 100% rename from docs/man/cdist-explorer.rst rename to docs/src/cdist-explorer.rst diff --git a/docs/man/cdist-features.rst b/docs/src/cdist-features.rst similarity index 100% rename from docs/man/cdist-features.rst rename to docs/src/cdist-features.rst diff --git a/docs/man/cdist-hacker.rst b/docs/src/cdist-hacker.rst similarity index 100% rename from docs/man/cdist-hacker.rst rename to docs/src/cdist-hacker.rst diff --git a/docs/man/cdist-install.rst b/docs/src/cdist-install.rst similarity index 100% rename from docs/man/cdist-install.rst rename to docs/src/cdist-install.rst diff --git a/docs/man/cdist-intro.rst b/docs/src/cdist-intro.rst similarity index 100% rename from docs/man/cdist-intro.rst rename to docs/src/cdist-intro.rst diff --git a/docs/man/cdist-logo.png b/docs/src/cdist-logo.png similarity index 100% rename from docs/man/cdist-logo.png rename to docs/src/cdist-logo.png diff --git a/docs/man/cdist-manifest.rst b/docs/src/cdist-manifest.rst similarity index 100% rename from docs/man/cdist-manifest.rst rename to docs/src/cdist-manifest.rst diff --git a/docs/man/cdist-messaging.rst b/docs/src/cdist-messaging.rst similarity index 100% rename from docs/man/cdist-messaging.rst rename to docs/src/cdist-messaging.rst diff --git a/docs/man/cdist-os.rst b/docs/src/cdist-os.rst similarity index 100% rename from docs/man/cdist-os.rst rename to docs/src/cdist-os.rst diff --git a/docs/man/cdist-quickstart.rst b/docs/src/cdist-quickstart.rst similarity index 100% rename from docs/man/cdist-quickstart.rst rename to docs/src/cdist-quickstart.rst diff --git a/docs/man/cdist-reference.rst.sh b/docs/src/cdist-reference.rst.sh similarity index 100% rename from docs/man/cdist-reference.rst.sh rename to docs/src/cdist-reference.rst.sh diff --git a/docs/man/cdist-remote-exec-copy.rst b/docs/src/cdist-remote-exec-copy.rst similarity index 100% rename from docs/man/cdist-remote-exec-copy.rst rename to docs/src/cdist-remote-exec-copy.rst diff --git a/docs/man/cdist-stages.rst b/docs/src/cdist-stages.rst similarity index 100% rename from docs/man/cdist-stages.rst rename to docs/src/cdist-stages.rst diff --git a/docs/man/cdist-support.rst b/docs/src/cdist-support.rst similarity index 100% rename from docs/man/cdist-support.rst rename to docs/src/cdist-support.rst diff --git a/docs/man/cdist-troubleshooting.rst b/docs/src/cdist-troubleshooting.rst similarity index 100% rename from docs/man/cdist-troubleshooting.rst rename to docs/src/cdist-troubleshooting.rst diff --git a/docs/man/cdist-type.rst b/docs/src/cdist-type.rst similarity index 100% rename from docs/man/cdist-type.rst rename to docs/src/cdist-type.rst diff --git a/docs/man/cdist-types.rst b/docs/src/cdist-types.rst similarity index 100% rename from docs/man/cdist-types.rst rename to docs/src/cdist-types.rst diff --git a/docs/man/cdist-update.rst b/docs/src/cdist-update.rst similarity index 100% rename from docs/man/cdist-update.rst rename to docs/src/cdist-update.rst diff --git a/docs/man/cdist-why.rst b/docs/src/cdist-why.rst similarity index 100% rename from docs/man/cdist-why.rst rename to docs/src/cdist-why.rst diff --git a/docs/man/conf.py b/docs/src/conf.py similarity index 100% rename from docs/man/conf.py rename to docs/src/conf.py diff --git a/docs/man/index.rst b/docs/src/index.rst similarity index 100% rename from docs/man/index.rst rename to docs/src/index.rst diff --git a/docs/man/man1/cdist.rst b/docs/src/man1/cdist.rst similarity index 100% rename from docs/man/man1/cdist.rst rename to docs/src/man1/cdist.rst diff --git a/docs/man/man7/.gitignore b/docs/src/man7/.gitignore similarity index 100% rename from docs/man/man7/.gitignore rename to docs/src/man7/.gitignore From 0dfb4aee73aa353ae71606828eeaa7563a0b2421 Mon Sep 17 00:00:00 2001 From: Darko Poljak Date: Thu, 30 Jun 2016 15:12:32 +0200 Subject: [PATCH 2/6] sphinx> ':manpage:' -> ':strong:' --- cdist/conf/type/__ccollect_source/man.rst | 2 +- cdist/conf/type/__config_file/man.rst | 2 +- cdist/conf/type/__consul_check/man.rst | 2 +- cdist/conf/type/__consul_service/man.rst | 2 +- cdist/conf/type/__consul_template_template/man.rst | 2 +- cdist/conf/type/__consul_watch_checks/man.rst | 2 +- cdist/conf/type/__consul_watch_event/man.rst | 2 +- cdist/conf/type/__consul_watch_key/man.rst | 2 +- cdist/conf/type/__consul_watch_keyprefix/man.rst | 2 +- cdist/conf/type/__consul_watch_nodes/man.rst | 2 +- cdist/conf/type/__consul_watch_service/man.rst | 2 +- cdist/conf/type/__consul_watch_services/man.rst | 2 +- cdist/conf/type/__cron/man.rst | 2 +- cdist/conf/type/__debconf_set_selections/man.rst | 2 +- cdist/conf/type/__dog_vdi/man.rst | 2 +- cdist/conf/type/__firewalld_rule/man.rst | 2 +- cdist/conf/type/__iptables_apply/man.rst | 2 +- cdist/conf/type/__iptables_rule/man.rst | 2 +- cdist/conf/type/__jail/man.rst | 2 +- cdist/conf/type/__jail_freebsd10/man.rst | 2 +- cdist/conf/type/__jail_freebsd9/man.rst | 2 +- cdist/conf/type/__line/man.rst | 2 +- cdist/conf/type/__locale/man.rst | 2 +- cdist/conf/type/__package_apt/man.rst | 2 +- cdist/conf/type/__package_emerge/man.rst | 2 +- cdist/conf/type/__package_emerge_dependencies/man.rst | 2 +- cdist/conf/type/__package_luarocks/man.rst | 2 +- cdist/conf/type/__package_opkg/man.rst | 2 +- cdist/conf/type/__package_pacman/man.rst | 2 +- cdist/conf/type/__package_pip/man.rst | 2 +- cdist/conf/type/__package_pkg_freebsd/man.rst | 2 +- cdist/conf/type/__package_pkg_openbsd/man.rst | 2 +- cdist/conf/type/__package_pkgng_freebsd/man.rst | 2 +- cdist/conf/type/__package_rubygem/man.rst | 2 +- cdist/conf/type/__package_yum/man.rst | 2 +- cdist/conf/type/__package_zypper/man.rst | 2 +- cdist/conf/type/__pacman_conf/man.rst | 2 +- cdist/conf/type/__pacman_conf_integrate/man.rst | 2 +- cdist/conf/type/__pf_apply/man.rst | 2 +- cdist/conf/type/__pf_ruleset/man.rst | 2 +- cdist/conf/type/__postfix_master/man.rst | 2 +- cdist/conf/type/__postfix_postconf/man.rst | 2 +- cdist/conf/type/__postgres_database/man.rst | 2 +- cdist/conf/type/__postgres_role/man.rst | 2 +- cdist/conf/type/__process/man.rst | 2 +- cdist/conf/type/__qemu_img/man.rst | 2 +- cdist/conf/type/__rsync/man.rst | 2 +- cdist/conf/type/__rvm/man.rst | 4 ++-- cdist/conf/type/__rvm_gem/man.rst | 4 ++-- cdist/conf/type/__rvm_gemset/man.rst | 4 ++-- cdist/conf/type/__rvm_ruby/man.rst | 4 ++-- cdist/conf/type/__ssh_authorized_key/man.rst | 2 +- cdist/conf/type/__ssh_authorized_keys/man.rst | 2 +- cdist/conf/type/__ssh_dot_ssh/man.rst | 2 +- cdist/conf/type/__staged_file/man.rst | 2 +- cdist/conf/type/__start_on_boot/man.rst | 2 +- cdist/conf/type/__update_alternatives/man.rst | 2 +- cdist/conf/type/__user/man.rst | 2 +- 58 files changed, 62 insertions(+), 62 deletions(-) diff --git a/cdist/conf/type/__ccollect_source/man.rst b/cdist/conf/type/__ccollect_source/man.rst index cdacd31c..a6723fa8 100644 --- a/cdist/conf/type/__ccollect_source/man.rst +++ b/cdist/conf/type/__ccollect_source/man.rst @@ -53,7 +53,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`ccollect`\ (1) +:strong:`ccollect`\ (1) AUTHORS diff --git a/cdist/conf/type/__config_file/man.rst b/cdist/conf/type/__config_file/man.rst index b9d58979..414a970b 100644 --- a/cdist/conf/type/__config_file/man.rst +++ b/cdist/conf/type/__config_file/man.rst @@ -48,7 +48,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__file`\ (7) +:strong:`cdist-type__file`\ (7) AUTHORS diff --git a/cdist/conf/type/__consul_check/man.rst b/cdist/conf/type/__consul_check/man.rst index c0d0b459..e371f861 100644 --- a/cdist/conf/type/__consul_check/man.rst +++ b/cdist/conf/type/__consul_check/man.rst @@ -62,7 +62,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__consul_agent`\ (7) +:strong:`cdist-type__consul_agent`\ (7) AUTHORS diff --git a/cdist/conf/type/__consul_service/man.rst b/cdist/conf/type/__consul_service/man.rst index 75b06aa0..0c815402 100644 --- a/cdist/conf/type/__consul_service/man.rst +++ b/cdist/conf/type/__consul_service/man.rst @@ -66,7 +66,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__consul_agent`\ (7) +:strong:`cdist-type__consul_agent`\ (7) AUTHORS diff --git a/cdist/conf/type/__consul_template_template/man.rst b/cdist/conf/type/__consul_template_template/man.rst index b54f759e..c1da282e 100644 --- a/cdist/conf/type/__consul_template_template/man.rst +++ b/cdist/conf/type/__consul_template_template/man.rst @@ -59,7 +59,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__consul_template`\ (7), :manpage:`cdist-type__consul_template_config`\ (7) +:strong:`cdist-type__consul_template`\ (7), :strong:`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 ec04b0b3..35c8c9ca 100644 --- a/cdist/conf/type/__consul_watch_checks/man.rst +++ b/cdist/conf/type/__consul_watch_checks/man.rst @@ -55,7 +55,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__consul_agent`\ (7) +:strong:`cdist-type__consul_agent`\ (7) consul documentation at: . diff --git a/cdist/conf/type/__consul_watch_event/man.rst b/cdist/conf/type/__consul_watch_event/man.rst index 664a19a2..03c2f07e 100644 --- a/cdist/conf/type/__consul_watch_event/man.rst +++ b/cdist/conf/type/__consul_watch_event/man.rst @@ -48,7 +48,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__consul_agent`\ (7) +:strong:`cdist-type__consul_agent`\ (7) consul documentation at: . diff --git a/cdist/conf/type/__consul_watch_key/man.rst b/cdist/conf/type/__consul_watch_key/man.rst index 0f90245c..efa6cb41 100644 --- a/cdist/conf/type/__consul_watch_key/man.rst +++ b/cdist/conf/type/__consul_watch_key/man.rst @@ -45,7 +45,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__consul_agent`\ (7) +:strong:`cdist-type__consul_agent`\ (7) consul documentation at: . diff --git a/cdist/conf/type/__consul_watch_keyprefix/man.rst b/cdist/conf/type/__consul_watch_keyprefix/man.rst index 65fa16af..d884eb79 100644 --- a/cdist/conf/type/__consul_watch_keyprefix/man.rst +++ b/cdist/conf/type/__consul_watch_keyprefix/man.rst @@ -45,7 +45,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__consul_agent`\ (7) +:strong:`cdist-type__consul_agent`\ (7) consul documentation at: . diff --git a/cdist/conf/type/__consul_watch_nodes/man.rst b/cdist/conf/type/__consul_watch_nodes/man.rst index 5a5bdbd2..52974c3c 100644 --- a/cdist/conf/type/__consul_watch_nodes/man.rst +++ b/cdist/conf/type/__consul_watch_nodes/man.rst @@ -41,7 +41,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__consul_agent`\ (7) +:strong:`cdist-type__consul_agent`\ (7) consul documentation at: . diff --git a/cdist/conf/type/__consul_watch_service/man.rst b/cdist/conf/type/__consul_watch_service/man.rst index 38ee501a..f22ee568 100644 --- a/cdist/conf/type/__consul_watch_service/man.rst +++ b/cdist/conf/type/__consul_watch_service/man.rst @@ -65,7 +65,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__consul_agent`\ (7) +:strong:`cdist-type__consul_agent`\ (7) consul documentation at: . diff --git a/cdist/conf/type/__consul_watch_services/man.rst b/cdist/conf/type/__consul_watch_services/man.rst index 41b115ae..c53caa04 100644 --- a/cdist/conf/type/__consul_watch_services/man.rst +++ b/cdist/conf/type/__consul_watch_services/man.rst @@ -41,7 +41,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__consul_agent`\ (7) +:strong:`cdist-type__consul_agent`\ (7) consul documentation at: . diff --git a/cdist/conf/type/__cron/man.rst b/cdist/conf/type/__cron/man.rst index 4b9cb83d..59f59e14 100644 --- a/cdist/conf/type/__cron/man.rst +++ b/cdist/conf/type/__cron/man.rst @@ -68,7 +68,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`crontab`\ (5) +:strong:`crontab`\ (5) AUTHORS diff --git a/cdist/conf/type/__debconf_set_selections/man.rst b/cdist/conf/type/__debconf_set_selections/man.rst index b7e5f901..3f7f05ae 100644 --- a/cdist/conf/type/__debconf_set_selections/man.rst +++ b/cdist/conf/type/__debconf_set_selections/man.rst @@ -37,7 +37,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`debconf-set-selections`\ (1), :manpage:`cdist-type__update_alternatives`\ (7) +:strong:`debconf-set-selections`\ (1), :strong:`cdist-type__update_alternatives`\ (7) AUTHORS diff --git a/cdist/conf/type/__dog_vdi/man.rst b/cdist/conf/type/__dog_vdi/man.rst index 65bea479..2d6f15b8 100644 --- a/cdist/conf/type/__dog_vdi/man.rst +++ b/cdist/conf/type/__dog_vdi/man.rst @@ -43,7 +43,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`qemu`\ (1), :manpage:`dog`\ (8) +:strong:`qemu`\ (1), :strong:`dog`\ (8) AUTHORS diff --git a/cdist/conf/type/__firewalld_rule/man.rst b/cdist/conf/type/__firewalld_rule/man.rst index 414eb7e9..5e8e25a7 100644 --- a/cdist/conf/type/__firewalld_rule/man.rst +++ b/cdist/conf/type/__firewalld_rule/man.rst @@ -65,7 +65,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__iptables_rule`\ (7), :manpage:`firewalld`\ (8) +:strong:`cdist-type__iptables_rule`\ (7), :strong:`firewalld`\ (8) AUTHORS diff --git a/cdist/conf/type/__iptables_apply/man.rst b/cdist/conf/type/__iptables_apply/man.rst index 48697f9c..6f9ab923 100644 --- a/cdist/conf/type/__iptables_apply/man.rst +++ b/cdist/conf/type/__iptables_apply/man.rst @@ -29,7 +29,7 @@ None (__iptables_apply is used by __iptables_rule) SEE ALSO -------- -:manpage:`cdist-type__iptables_rule`\ (7), :manpage:`iptables`\ (8) +:strong:`cdist-type__iptables_rule`\ (7), :strong:`iptables`\ (8) AUTHORS diff --git a/cdist/conf/type/__iptables_rule/man.rst b/cdist/conf/type/__iptables_rule/man.rst index fab6c47a..5256c711 100644 --- a/cdist/conf/type/__iptables_rule/man.rst +++ b/cdist/conf/type/__iptables_rule/man.rst @@ -50,7 +50,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__iptables_apply`\ (7), :manpage:`iptables`\ (8) +:strong:`cdist-type__iptables_apply`\ (7), :strong:`iptables`\ (8) AUTHORS diff --git a/cdist/conf/type/__jail/man.rst b/cdist/conf/type/__jail/man.rst index 756e7660..bd9826e4 100644 --- a/cdist/conf/type/__jail/man.rst +++ b/cdist/conf/type/__jail/man.rst @@ -108,7 +108,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`jail`\ (8) +:strong:`jail`\ (8) AUTHORS diff --git a/cdist/conf/type/__jail_freebsd10/man.rst b/cdist/conf/type/__jail_freebsd10/man.rst index 34dc2198..9efd7c2a 100644 --- a/cdist/conf/type/__jail_freebsd10/man.rst +++ b/cdist/conf/type/__jail_freebsd10/man.rst @@ -107,7 +107,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`jail`\ (8) +:strong:`jail`\ (8) AUTHORS diff --git a/cdist/conf/type/__jail_freebsd9/man.rst b/cdist/conf/type/__jail_freebsd9/man.rst index ca526cd0..fe32010d 100644 --- a/cdist/conf/type/__jail_freebsd9/man.rst +++ b/cdist/conf/type/__jail_freebsd9/man.rst @@ -108,7 +108,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`jail`\ (8) +:strong:`jail`\ (8) AUTHORS diff --git a/cdist/conf/type/__line/man.rst b/cdist/conf/type/__line/man.rst index 1f38a974..11840bac 100644 --- a/cdist/conf/type/__line/man.rst +++ b/cdist/conf/type/__line/man.rst @@ -61,7 +61,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`grep`\ (1) +:strong:`grep`\ (1) AUTHORS diff --git a/cdist/conf/type/__locale/man.rst b/cdist/conf/type/__locale/man.rst index 51ed38df..e46d14bd 100644 --- a/cdist/conf/type/__locale/man.rst +++ b/cdist/conf/type/__locale/man.rst @@ -34,7 +34,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`locale`\ (1), :manpage:`localedef`\ (1) +:strong:`locale`\ (1), :strong:`localedef`\ (1) AUTHORS diff --git a/cdist/conf/type/__package_apt/man.rst b/cdist/conf/type/__package_apt/man.rst index a841fc5b..45818636 100644 --- a/cdist/conf/type/__package_apt/man.rst +++ b/cdist/conf/type/__package_apt/man.rst @@ -46,7 +46,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7) +:strong:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_emerge/man.rst b/cdist/conf/type/__package_emerge/man.rst index ceb0f169..839b647e 100644 --- a/cdist/conf/type/__package_emerge/man.rst +++ b/cdist/conf/type/__package_emerge/man.rst @@ -47,7 +47,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7), :manpage:`cdist-type__package_emerge_dependencies`\ (7) +:strong:`cdist-type__package`\ (7), :strong:`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 1a227853..11531b34 100644 --- a/cdist/conf/type/__package_emerge_dependencies/man.rst +++ b/cdist/conf/type/__package_emerge_dependencies/man.rst @@ -36,7 +36,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7), :manpage:`cdist-type__package_emerge`\ (7) +:strong:`cdist-type__package`\ (7), :strong:`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 399b07af..fd831aa5 100644 --- a/cdist/conf/type/__package_luarocks/man.rst +++ b/cdist/conf/type/__package_luarocks/man.rst @@ -39,7 +39,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7) +:strong:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_opkg/man.rst b/cdist/conf/type/__package_opkg/man.rst index 203b8a36..d7858ba2 100644 --- a/cdist/conf/type/__package_opkg/man.rst +++ b/cdist/conf/type/__package_opkg/man.rst @@ -39,7 +39,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7) +:strong:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_pacman/man.rst b/cdist/conf/type/__package_pacman/man.rst index 44f36255..7b9bd1b4 100644 --- a/cdist/conf/type/__package_pacman/man.rst +++ b/cdist/conf/type/__package_pacman/man.rst @@ -42,7 +42,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7) +:strong:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_pip/man.rst b/cdist/conf/type/__package_pip/man.rst index f1ba98d9..85d6d42b 100644 --- a/cdist/conf/type/__package_pip/man.rst +++ b/cdist/conf/type/__package_pip/man.rst @@ -49,7 +49,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7) +:strong:`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 a2633bcb..4b210356 100644 --- a/cdist/conf/type/__package_pkg_freebsd/man.rst +++ b/cdist/conf/type/__package_pkg_freebsd/man.rst @@ -54,7 +54,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7) +:strong:`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 e776956c..0814029f 100644 --- a/cdist/conf/type/__package_pkg_openbsd/man.rst +++ b/cdist/conf/type/__package_pkg_openbsd/man.rst @@ -54,7 +54,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7) +:strong:`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 9fdd7c76..bdc268af 100644 --- a/cdist/conf/type/__package_pkgng_freebsd/man.rst +++ b/cdist/conf/type/__package_pkgng_freebsd/man.rst @@ -85,7 +85,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7) +:strong:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_rubygem/man.rst b/cdist/conf/type/__package_rubygem/man.rst index eb76a036..5bec9d2d 100644 --- a/cdist/conf/type/__package_rubygem/man.rst +++ b/cdist/conf/type/__package_rubygem/man.rst @@ -39,7 +39,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7) +:strong:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_yum/man.rst b/cdist/conf/type/__package_yum/man.rst index 544afbf2..581d3539 100644 --- a/cdist/conf/type/__package_yum/man.rst +++ b/cdist/conf/type/__package_yum/man.rst @@ -49,7 +49,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7) +:strong:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__package_zypper/man.rst b/cdist/conf/type/__package_zypper/man.rst index da8d1d81..cb9cb518 100644 --- a/cdist/conf/type/__package_zypper/man.rst +++ b/cdist/conf/type/__package_zypper/man.rst @@ -56,7 +56,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__package`\ (7) +:strong:`cdist-type__package`\ (7) AUTHORS diff --git a/cdist/conf/type/__pacman_conf/man.rst b/cdist/conf/type/__pacman_conf/man.rst index a61f2498..931f8812 100644 --- a/cdist/conf/type/__pacman_conf/man.rst +++ b/cdist/conf/type/__pacman_conf/man.rst @@ -59,7 +59,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`grep`\ (1) +:strong:`grep`\ (1) AUTHORS diff --git a/cdist/conf/type/__pacman_conf_integrate/man.rst b/cdist/conf/type/__pacman_conf_integrate/man.rst index 77d5c1c3..f36dca45 100644 --- a/cdist/conf/type/__pacman_conf_integrate/man.rst +++ b/cdist/conf/type/__pacman_conf_integrate/man.rst @@ -35,7 +35,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`grep`\ (1) +:strong:`grep`\ (1) AUTHORS diff --git a/cdist/conf/type/__pf_apply/man.rst b/cdist/conf/type/__pf_apply/man.rst index 2c7fd4fb..1b7f4e3b 100644 --- a/cdist/conf/type/__pf_apply/man.rst +++ b/cdist/conf/type/__pf_apply/man.rst @@ -39,7 +39,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`pf`\ (4), :manpage:`cdist-type__pf_ruleset`\ (7) +:strong:`pf`\ (4), :strong:`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 eb97e086..756a9e30 100644 --- a/cdist/conf/type/__pf_ruleset/man.rst +++ b/cdist/conf/type/__pf_ruleset/man.rst @@ -39,7 +39,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`pf`\ (4) +:strong:`pf`\ (4) AUTHORS diff --git a/cdist/conf/type/__postfix_master/man.rst b/cdist/conf/type/__postfix_master/man.rst index 27078070..b6e6fc94 100644 --- a/cdist/conf/type/__postfix_master/man.rst +++ b/cdist/conf/type/__postfix_master/man.rst @@ -68,7 +68,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`master`\ (5) +:strong:`master`\ (5) AUTHORS diff --git a/cdist/conf/type/__postfix_postconf/man.rst b/cdist/conf/type/__postfix_postconf/man.rst index 5773fcaf..5c2c2a0e 100644 --- a/cdist/conf/type/__postfix_postconf/man.rst +++ b/cdist/conf/type/__postfix_postconf/man.rst @@ -38,7 +38,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`postconf`\ (5) +:strong:`postconf`\ (5) AUTHORS diff --git a/cdist/conf/type/__postgres_database/man.rst b/cdist/conf/type/__postgres_database/man.rst index 69e1a67f..517c12a3 100644 --- a/cdist/conf/type/__postgres_database/man.rst +++ b/cdist/conf/type/__postgres_database/man.rst @@ -30,7 +30,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__postgres_role`\ (7) +:strong:`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 f9293be5..a2a0268a 100644 --- a/cdist/conf/type/__postgres_role/man.rst +++ b/cdist/conf/type/__postgres_role/man.rst @@ -48,7 +48,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__postgres_database`\ (7) +:strong:`cdist-type__postgres_database`\ (7) postgresql documentation at: . diff --git a/cdist/conf/type/__process/man.rst b/cdist/conf/type/__process/man.rst index 19f68ddc..0e4690b1 100644 --- a/cdist/conf/type/__process/man.rst +++ b/cdist/conf/type/__process/man.rst @@ -58,7 +58,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__start_on_boot`\ (7) +:strong:`cdist-type__start_on_boot`\ (7) AUTHORS diff --git a/cdist/conf/type/__qemu_img/man.rst b/cdist/conf/type/__qemu_img/man.rst index 7cb4a758..663e9162 100644 --- a/cdist/conf/type/__qemu_img/man.rst +++ b/cdist/conf/type/__qemu_img/man.rst @@ -37,7 +37,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`qemu-img`\ (1) +:strong:`qemu-img`\ (1) AUTHORS diff --git a/cdist/conf/type/__rsync/man.rst b/cdist/conf/type/__rsync/man.rst index 28e85ab2..295feceb 100644 --- a/cdist/conf/type/__rsync/man.rst +++ b/cdist/conf/type/__rsync/man.rst @@ -98,7 +98,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`rsync`\ (1) +:strong:`rsync`\ (1) AUTHORS diff --git a/cdist/conf/type/__rvm/man.rst b/cdist/conf/type/__rvm/man.rst index 412b651d..3a914304 100644 --- a/cdist/conf/type/__rvm/man.rst +++ b/cdist/conf/type/__rvm/man.rst @@ -31,8 +31,8 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__rvm_gem`\ (7), :manpage:`cdist-type__rvm_gemset`\ (7), -:manpage:`cdist-type__rvm_ruby`\ (7) +:strong:`cdist-type__rvm_gem`\ (7), :strong:`cdist-type__rvm_gemset`\ (7), +:strong:`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 a60fe843..5f3fba97 100644 --- a/cdist/conf/type/__rvm_gem/man.rst +++ b/cdist/conf/type/__rvm_gem/man.rst @@ -43,8 +43,8 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__rvm`\ (7), :manpage:`cdist-type__rvm_gemset`\ (7), -:manpage:`cdist-type__rvm_ruby`\ (7) +:strong:`cdist-type__rvm`\ (7), :strong:`cdist-type__rvm_gemset`\ (7), +:strong:`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 4259ec92..fca4c36a 100644 --- a/cdist/conf/type/__rvm_gemset/man.rst +++ b/cdist/conf/type/__rvm_gemset/man.rst @@ -41,8 +41,8 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__rvm`\ (7), :manpage:`cdist-type__rvm_gem`\ (7), -:manpage:`cdist-type__rvm_ruby`\ (7) +:strong:`cdist-type__rvm`\ (7), :strong:`cdist-type__rvm_gem`\ (7), +:strong:`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 18b6044b..f6e71e12 100644 --- a/cdist/conf/type/__rvm_ruby/man.rst +++ b/cdist/conf/type/__rvm_ruby/man.rst @@ -42,8 +42,8 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__rvm`\ (7), :manpage:`cdist-type__rvm_gem`\ (7), -:manpage:`cdist-type__rvm_gemset`\ (7) +:strong:`cdist-type__rvm`\ (7), :strong:`cdist-type__rvm_gem`\ (7), +:strong:`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 3585717f..a65ebdd9 100644 --- a/cdist/conf/type/__ssh_authorized_key/man.rst +++ b/cdist/conf/type/__ssh_authorized_key/man.rst @@ -55,7 +55,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist__ssh_authorized_keys`\ (7), :manpage:`sshd`\ (8) +:strong:`cdist__ssh_authorized_keys`\ (7), :strong:`sshd`\ (8) AUTHORS diff --git a/cdist/conf/type/__ssh_authorized_keys/man.rst b/cdist/conf/type/__ssh_authorized_keys/man.rst index 6729660e..e6829883 100644 --- a/cdist/conf/type/__ssh_authorized_keys/man.rst +++ b/cdist/conf/type/__ssh_authorized_keys/man.rst @@ -105,7 +105,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`sshd`\ (8) +:strong:`sshd`\ (8) AUTHORS diff --git a/cdist/conf/type/__ssh_dot_ssh/man.rst b/cdist/conf/type/__ssh_dot_ssh/man.rst index 75adbde0..3084d60d 100644 --- a/cdist/conf/type/__ssh_dot_ssh/man.rst +++ b/cdist/conf/type/__ssh_dot_ssh/man.rst @@ -33,7 +33,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__ssh_authorized_keys`\ (7) +:strong:`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 d11338af..3d8ee966 100644 --- a/cdist/conf/type/__staged_file/man.rst +++ b/cdist/conf/type/__staged_file/man.rst @@ -99,7 +99,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__file`\ (7) +:strong:`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 70c3e8d4..4d4dd631 100644 --- a/cdist/conf/type/__start_on_boot/man.rst +++ b/cdist/conf/type/__start_on_boot/man.rst @@ -45,7 +45,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__process`\ (7) +:strong:`cdist-type__process`\ (7) AUTHORS diff --git a/cdist/conf/type/__update_alternatives/man.rst b/cdist/conf/type/__update_alternatives/man.rst index c2b8bf6d..2fff3cba 100644 --- a/cdist/conf/type/__update_alternatives/man.rst +++ b/cdist/conf/type/__update_alternatives/man.rst @@ -30,7 +30,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`cdist-type__debconf_set_selections`\ (7), :manpage:`update-alternatives`\ (8) +:strong:`cdist-type__debconf_set_selections`\ (7), :strong:`update-alternatives`\ (8) AUTHORS diff --git a/cdist/conf/type/__user/man.rst b/cdist/conf/type/__user/man.rst index 1ad17b5b..172bde7c 100644 --- a/cdist/conf/type/__user/man.rst +++ b/cdist/conf/type/__user/man.rst @@ -84,7 +84,7 @@ EXAMPLES SEE ALSO -------- -:manpage:`pw`\ (8), :manpage:`usermod`\ (8) +:strong:`pw`\ (8), :strong:`usermod`\ (8) AUTHORS From 0f8ec6ce3a06164a37112c57f9247df94d44354d Mon Sep 17 00:00:00 2001 From: Darko Poljak Date: Thu, 30 Jun 2016 15:24:14 +0200 Subject: [PATCH 3/6] Update docs installation chapter. --- docs/src/cdist-install.rst | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/src/cdist-install.rst b/docs/src/cdist-install.rst index f950a1ee..a94c12a3 100644 --- a/docs/src/cdist-install.rst +++ b/docs/src/cdist-install.rst @@ -68,19 +68,31 @@ If the main site is down, you can acquire cdist from one of the following sites: * git://github.com/telmich/cdist.git `github `_ * git://git.code.sf.net/p/cdist/code `sourceforge `_ -Building and using manpages -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Building and using documentation (man and html) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If you want to build and use the manpages, run: +If you want to build and use the documentation, run: + +.. code-block:: sh + + make docs + +Documentation comes in two formats, man pages and full HTML +documentation. Documentation is built into distribution's +docs/dist directory. man pages are in docs/dist/man and +HTML documentation in docs/dist/html. + +If you want to use man pages, run: .. code-block:: sh - make man export MANPATH=$MANPATH:$(pwd -P)/docs/dist/man Or you can move manpages from docs/dist/man directory to some other directory and add it to MANPATH. +Full HTML documentation can be accessed at docs/dist/html/index.html. + You can also build manpages for types in your ~/.cdist directory: .. code-block:: sh @@ -94,17 +106,6 @@ some other custom .cdist directory, e.g. /opt/cdist then use: 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 ~~~~~~~~~~~~~~ From 76563756eeb259559c821200257f5c9143948e2a Mon Sep 17 00:00:00 2001 From: Darko Poljak Date: Thu, 30 Jun 2016 15:28:57 +0200 Subject: [PATCH 4/6] Update Nico's cdist main page with installation instructions. --- docs/web/cdist/install.mdwn | 143 ++++++++---------------------------- 1 file changed, 30 insertions(+), 113 deletions(-) diff --git a/docs/web/cdist/install.mdwn b/docs/web/cdist/install.mdwn index ce6ca877..b3724911 100644 --- a/docs/web/cdist/install.mdwn +++ b/docs/web/cdist/install.mdwn @@ -17,114 +17,6 @@ This is the machine you use to configure the target hosts. * /bin/sh: A posix like shell (for instance bash, dash, zsh) * SSH server -## Requirement Installation: Python >= 3.2 - -Ensure you have at least Python 3.2 or newer installed on -the **source host**. -You can check this by running **python -V**: - - % python -V - Python 3.3.0 - -### Archlinux - -Archlinux includes a recent python in the extra repository. -You can install it using - - pacman -S python - -### CentOS - -See the "From source" section - -### Debian - -For Debian **wheezy** or newer: - - aptitude install python3 - -On **squeeze** you can add following line in **/etc/apt/sources.list** - - deb http://ftp.debian.org/debian wheezy main - -And add pinning entry in **/etc/apt/preferences.d/wheezy**: - - Package: * - Pin: release n=wheezy - Pin-Priority: 1 - -Please be aware that both **openssh-server** and **openssh-client** might be -removed on **python3.2** installation. You surely want to reinstall them: - - apt-get install -t wheezy openssh-server openssh-client - -For older Debian versions, installing python 3.2 from source is required. - -If you want to build the cdist manpages: - - aptitude install --without-recommends asciidoc xsltproc - -### Fedora - -Fedora 15 and newer includes a recent python. -You can install it using - - yum install python3 - -### FreeBSD - -For the port: - - cd /usr/ports/lang/python32/ && make install clean - -For the package: - - pkg_add -r python32 - -You can also use any newer version, but at least python 3.2 is required. - -### Gentoo - -Gentoo only provides python 3.2 in testing packages (http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=3&chap=3). -If you want to ensure nothing breaks you must set back the python version to what was default before. - - emerge -av =python-3.2.2 --autounmask-write - emerge -av =python-3.2.2 - eselect python list - eselect python list set python3.2 - -### Max OS X - -You can choose between Homebrew and Macports, either way works: - -[Homebrew](http://mxcl.github.com/homebrew/) variant: - - brew install python3 - -[Macports](http://www.macports.org/install.php) variant: - - port install python32 - ln -s /opt/local/bin/python3.2 /opt/local/bin/python3 - -### Redhat - -See the "From source" section - -### From Source - -For those operating systems not yet supporting Python 3.2: - - pyversion=3.2.3 - wget http://www.python.org/ftp/python/$pyversion/Python-${pyversion}.tar.bz2 - tar xvfj Python-${pyversion}.tar.bz2 - cd Python-${pyversion} - ./configure - make - sudo make install - -This installs python 3.2 to /usr/local/bin. -Ensure this directory is in your PATH environment variable. - ## Install cdist You can install cdist either from git or as a python package. @@ -141,11 +33,6 @@ To install cdist, execute the following commands: cd cdist export PATH=$PATH:$(pwd -P)/bin -If you want to build and use the manpages, run: - - make man - export MANPATH=$MANPATH:$(pwd -P)/doc/man - #### Available versions in git * The active development takes place in the **master** branch @@ -169,6 +56,36 @@ If the main site is down, you can acquire cdist from one of the following sites: * git://github.com/telmich/cdist.git ([github](https://github.com/telmich/cdist)) * git://git.code.sf.net/p/cdist/code ([sourceforge](https://sourceforge.net/p/cdist/code)) +#### Building and using documentation (man and html) + +If you want to build and use the documentation, run: + + make docs + +Documentation comes in two formats, man pages and full HTML +documentation. Documentation is built into distribution's +docs/dist directory. man pages are in docs/dist/man and +HTML documentation in docs/dist/html. + +If you want to use man pages, run: + + export MANPATH=$MANPATH:$(pwd -P)/docs/dist/man + +Or you can move manpages from docs/dist/man directory to some +other directory and add it to MANPATH. + +Full HTML documentation can be accessed at docs/dist/html/index.html. + +You can also build manpages for types in your ~/.cdist directory: + + make dotman + +Built manpages are now in docs/dist/man directory. If you have +some other custom .cdist directory, e.g. /opt/cdist then use: + + DOT_CDIST_PATH=/opt/cdist make dotman + + ### Python Package Cdist is available as a python package at From 4dac520d9875865186cb0cbcdebc3e17579e9e1d Mon Sep 17 00:00:00 2001 From: Darko Poljak Date: Mon, 4 Jul 2016 12:21:01 +0200 Subject: [PATCH 5/6] Implement make targets: man, html, docs. --- Makefile | 11 ++++------- docs/src/cdist-install.rst | 21 +++++++++++++++++---- docs/src/man1/cdist.rst | 4 ---- 3 files changed, 21 insertions(+), 15 deletions(-) diff --git a/Makefile b/Makefile index 7885cf24..e1abde88 100644 --- a/Makefile +++ b/Makefile @@ -63,13 +63,13 @@ $(DOCSREF): $(DOCSREFSH) $(DOCSREFSH) # Manpages #3: generic part -sphinxman: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION) +man: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION) $(SPHINXM) -sphinxhtml: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION) +html: $(MANTYPES) $(DOCSREF) $(PYTHON_VERSION) $(SPHINXH) -docs: sphinxman sphinxhtml +docs: man html # Manpages #5: release part MANWEBDIR=$(WEBBASE)/man/$(CHANGELOG_VERSION) @@ -102,12 +102,9 @@ $(DOTMAN7DSTDIR)/cdist-type%.rst: $(DOTTYPEDIR)/%/man.rst ln -sf "$^" $@ # Manpages #3: generic part -dotsphinxman: $(DOTMANTYPES) +dotman: $(DOTMANTYPES) $(SPHINXM) -dotman: dotsphinxman - - ################################################################################ # Speeches # diff --git a/docs/src/cdist-install.rst b/docs/src/cdist-install.rst index a94c12a3..38db1a4e 100644 --- a/docs/src/cdist-install.rst +++ b/docs/src/cdist-install.rst @@ -12,7 +12,7 @@ This is the machine you use to configure the target hosts. * /bin/sh: A posix like shell (for instance bash, dash, zsh) * Python >= 3.2 * SSH client - * sphinx (for building html docs and/or the manpages) + * sphinx (for building html docs and/or the man pages) Target Hosts ~~~~~~~~~~~~ @@ -88,18 +88,31 @@ If you want to use man pages, run: export MANPATH=$MANPATH:$(pwd -P)/docs/dist/man -Or you can move manpages from docs/dist/man directory to some +Or you can move man pages from docs/dist/man directory to some other directory and add it to MANPATH. Full HTML documentation can be accessed at docs/dist/html/index.html. -You can also build manpages for types in your ~/.cdist directory: +You can also build only man pages or only html documentation, for +only man pages run: + +.. code-block:: sh + + make man + +for only html documentation run: + +.. code-block:: sh + + make html + +You can also build man pages for types in your ~/.cdist directory: .. code-block:: sh make dotman -Built manpages are now in docs/dist/man directory. If you have +Built man pages are now in docs/dist/man directory. If you have some other custom .cdist directory, e.g. /opt/cdist then use: .. code-block:: sh diff --git a/docs/src/man1/cdist.rst b/docs/src/man1/cdist.rst index efc1a201..5b821d46 100644 --- a/docs/src/man1/cdist.rst +++ b/docs/src/man1/cdist.rst @@ -56,10 +56,6 @@ CONFIG ------ Configure one or more hosts -.. option:: -h, --help - - Show the help screen - .. option:: -c CONF_DIR, --conf-dir CONF_DIR Add a configuration directory. Can be specified multiple times. From e76d06b382aa3e8a8ea0791453fff3135ef061f6 Mon Sep 17 00:00:00 2001 From: Darko Poljak Date: Mon, 4 Jul 2016 16:56:07 +0200 Subject: [PATCH 6/6] Fix docs-dist target. --- Makefile | 6 +++--- docs/web/cdist/documentation.mdwn | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index e1abde88..05c8004e 100644 --- a/Makefile +++ b/Makefile @@ -73,15 +73,15 @@ docs: man html # Manpages #5: release part MANWEBDIR=$(WEBBASE)/man/$(CHANGELOG_VERSION) -MANBUILDDIR=docs/dist/html +HTMLBUILDDIR=docs/dist/html -docs-dist: man +docs-dist: html rm -rf "${MANWEBDIR}" mkdir -p "${MANWEBDIR}" # mkdir -p "${MANWEBDIR}/man1" "${MANWEBDIR}/man7" # cp ${MAN1DSTDIR}/*.html ${MAN1DSTDIR}/*.css ${MANWEBDIR}/man1 # cp ${MAN7DSTDIR}/*.html ${MAN7DSTDIR}/*.css ${MANWEBDIR}/man7 - cp -R ${MANBUILDDIR}/* ${MANWEBDIR} + cp -R ${HTMLBUILDDIR}/* ${MANWEBDIR} cd ${MANWEBDIR} && git add . && git commit -m "cdist manpages update: $(CHANGELOG_VERSION)" || true man-latest-link: web-pub diff --git a/docs/web/cdist/documentation.mdwn b/docs/web/cdist/documentation.mdwn index db25b566..56c2798e 100644 --- a/docs/web/cdist/documentation.mdwn +++ b/docs/web/cdist/documentation.mdwn @@ -1,7 +1,7 @@ [[!meta title="Documentation"]] -You can browse the latest -[latest version of the manpages](/software/cdist/man/latest) or +You can browse the +[latest version of the documentation](/software/cdist/man/latest) or have a look at [all versions](/software/cdist/man). You can also view [speeches about cdist](/software/cdist/speeches).