Better sphinx manpage ext. Add custom dotman Makefile target for custom .cdist directory.

This commit is contained in:
Darko Poljak 2016-06-23 16:08:59 +02:00
commit b89077f9a5
114 changed files with 549 additions and 122 deletions

View file

@ -161,7 +161,7 @@ text:
.PHONY: man
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
$(SPHINXBUILD) -b cman $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

View file

@ -37,7 +37,10 @@ exec > "$dest"
cat << eof
cdist-reference(7)
==================
Variable, path and type reference for cdist
NAME
----
cdist-reference - Variable, path and type reference for cdist
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -29,7 +29,9 @@ import os
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = [
'cdist.sphinxext.manpage',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -257,15 +259,18 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
mandir = os.path.dirname(os.path.realpath(__file__))
man_pages = []
root_mandir = os.path.dirname(os.path.realpath(__file__))
mandirs = []
for mansubdir in ('man1', 'man7'):
for root, dirs, files in os.walk(os.path.join(mandir, mansubdir)):
mandirs.append((os.path.join(root_mandir, mansubdir), mansubdir[-1]))
man_pages = []
for mandir, section in mandirs:
for root, dirs, files in os.walk(mandir):
for fname in files:
froot, fext = os.path.splitext(fname)
if fext == '.rst':
man_page = (os.path.join(mansubdir, froot), froot, '',
[], mansubdir[-1])
man_page = (os.path.join('man' + str(section), froot),
froot, '', [], section)
man_pages.append(man_page)
#man_pages = [

View file

@ -1,6 +1,9 @@
cdist(1)
========
Usable Configuration Management
NAME
----
cdist - Usable Configuration Management
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-best-practice(7)
======================
Practices used in real environments
NAME
----
cdist-best-practice - Practices used in real environments
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-bootstrap(7)
==================
Setup cdist environment
NAME
----
cdist-bootstrap - Setup cdist environment
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-explorer(7)
=================
Explore the target systems
NAME
----
cdist-explorer - Explore the target systems
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-hacker(7)
===============
How to get (stuff) into cdist
NAME
----
cdist-hacker - How to get (stuff) into cdist
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-manifest(7)
=================
(Re-)Use types
NAME
----
cdist-manifest - (Re-)Use types
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-messaging(7)
==================
How the initial manifest and types can communication
NAME
----
cdist-messaging - How the initial manifest and types can communication
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-quickstart(7)
===================
Jump in and enjoy cdist
NAME
----
cdist-quickstart - Jump in and enjoy cdist
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-remote-exec-copy(7)
=========================
How to use remote exec and copy
NAME
----
cdist-remote-exec-copy - How to use remote exec and copy
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-stages(7)
===============
Stages used during configuration deployment
NAME
----
cdist-stages - Stages used during configuration deployment
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-troubleshooting(7)
========================
Common problems and their solutions
NAME
----
cdist-troubleshooting - Common problems and their solutions
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-tutorial(7)
=================
A guided introduction into cdist
NAME
----
cdist-tutorial - A guided introduction into cdist
Nico Schottelius <nico-cdist--@--schottelius.org>

View file

@ -1,6 +1,9 @@
cdist-type(7)
=============
Functionality bundled
NAME
----
cdist-type - Functionality bundled
Nico Schottelius <nico-cdist--@--schottelius.org>