Class "BuildDoc": support "copyright"

Adds "author", "date", and "copyright" options. If "copyright" is not
provided but either "author" or "date" are, generate the copyright
string using them.
This commit is contained in:
Yclept Nemo 2015-01-25 16:12:38 -05:00
parent 8e1150c956
commit ffe331d822

View File

@ -77,6 +77,10 @@ class BuildDoc(Command):
('today=', None, 'How to format the current date, used as the '
'replacement for |today|'),
('link-index', 'i', 'Link index.html to the master doc'),
('copyright', None, 'The copyright string'),
('author', None, 'The documented project\'s author'),
('date', None, 'Dates of first publication and major revisions'),
]
boolean_options = ['fresh-env', 'all-files', 'link-index']
@ -91,6 +95,9 @@ class BuildDoc(Command):
self.today = ''
self.config_dir = None
self.link_index = False
self.copyright = ''
self.author = ''
self.date = ''
def _guess_source_dir(self):
for guess in ('doc', 'docs'):
@ -135,6 +142,8 @@ class BuildDoc(Command):
self.mkpath(self.doctree_dir)
self.builder_target_dir = os.path.join(self.build_dir, self.builder)
self.mkpath(self.builder_target_dir)
if not self.copyright and (self.author or self.date):
self.copyright = ", ".join((self.date, self.author))
def run(self):
if not color_terminal():
@ -152,6 +161,8 @@ class BuildDoc(Command):
confoverrides['release'] = self.release
if self.today:
confoverrides['today'] = self.today
if self.copyright:
confoverrides['copyright'] = self.copyright
app = Sphinx(self.source_dir, self.config_dir,
self.builder_target_dir, self.doctree_dir,
self.builder, confoverrides, status_stream,