1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
# -*- coding: utf-8 -*-
"""
sphinxlocal.builders.manpage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
A replacement for the manpage builder which come bundled with Sphinx.
:version: 0.1
:author: Nic Bernstein <nic@onlight.com>
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""
from os import path
from docutils.io import FileOutput
from docutils.frontend import OptionParser
from sphinx import addnodes
from sphinx.errors import SphinxError
from sphinx.builders import Builder
from sphinx.util.nodes import inline_all_toctrees
from sphinx.util.console import bold, darkgreen
from sphinx.writers.manpage import ManualPageWriter
from sphinx.builders.manpage import ManualPageBuilder
##
# Import our customized version of the stock Writer, which has the
# Translater in it.
from sphinxlocal.writers.manpage import CyrusManualPageWriter
class CyrusManualPageBuilder(ManualPageBuilder):
"""
Builds groff output in manual page format.
"""
name = 'cyrman'
format = 'man'
supported_image_types = []
#settings_spec = (u'No options defined.', u'', ())
#settings_defaults = {}
def init(self):
if not self.config.man_pages:
self.warn('no "man_pages" config value found; no manual pages '
'will be written')
def write(self, *ignored):
# overwritten -- use our own version of the Writer
docwriter = CyrusManualPageWriter(self)
docsettings = OptionParser(
defaults=self.env.settings,
components=(docwriter,),
read_config_files=True).get_default_values()
for info in self.config.man_pages:
docname, name, description, authors, section = info
if isinstance(authors, str):
if authors:
authors = [authors]
else:
authors = []
targetname = '%s.%s' % (name, section)
destination = FileOutput(
destination_path=path.join(self.outdir, targetname),
encoding='utf-8')
tree = self.env.get_doctree(docname)
docnames = set()
largetree = inline_all_toctrees(self, docnames, docname, tree,
darkgreen, [docname])
self.env.resolve_references(largetree, docname, self)
# remove pending_xref nodes
for pendingnode in largetree.traverse(addnodes.pending_xref):
pendingnode.replace_self(pendingnode.children)
largetree.settings = docsettings
largetree.settings.title = name
largetree.settings.subtitle = description
largetree.settings.authors = authors
largetree.settings.section = section
docwriter.write(largetree, destination)
def setup(app):
app.add_builder(CyrusManualPageBuilder)
return {'version': '0.1'}
|
