#!/usr/bin/env python import os, re, shutil, sys from distutils.version import LooseVersion from subprocess import check_call class Git: def __init__(self, dir): self.dir = dir def call(self, method, args, **kwargs): return check_call(['git', method] + list(args), **kwargs) def clone(self, *args): return self.call('clone', list(args) + [self.dir]) def checkout(self, *args): return self.call('checkout', args, cwd=self.dir) def clean(self, *args): return self.call('clean', args, cwd=self.dir) def reset(self, *args): return self.call('reset', args, cwd=self.dir) def pull(self, *args): return self.call('pull', args, cwd=self.dir) def update(self, *args): if not os.path.exists(self.dir): self.clone(*args) # Import the documentation build module. fmt_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) sys.path.insert(0, os.path.join(fmt_dir, 'doc')) import build build_dir = 'build' # Virtualenv and repos are cached to speed up builds. build.create_build_env(os.path.join(build_dir, 'virtualenv')) fmt_repo = Git(os.path.join(build_dir, 'fmt')) fmt_repo.update('git@github.com:fmtlib/fmt') doc_repo = Git(os.path.join(build_dir, 'fmtlib.github.io')) doc_repo.update('git@github.com:fmtlib/fmtlib.github.io') for version in ['1.0.0', '1.1.0', '2.0.0', '3.0.0']: fmt_repo.clean('-f', '-d') fmt_repo.reset('--hard') fmt_repo.checkout(version) target_doc_dir = os.path.join(fmt_repo.dir, 'doc') # Remove the old theme. for entry in os.listdir(target_doc_dir): path = os.path.join(target_doc_dir, entry) if os.path.isdir(path): shutil.rmtree(path) # Copy the new theme. for entry in ['_static', '_templates', 'basic-bootstrap', 'bootstrap', 'conf.py', 'fmt.less']: src = os.path.join(fmt_dir, 'doc', entry) dst = os.path.join(target_doc_dir, entry) copy = shutil.copytree if os.path.isdir(src) else shutil.copyfile copy(src, dst) # Rename index to contents. contents = os.path.join(target_doc_dir, 'contents.rst') if not os.path.exists(contents): os.rename(os.path.join(target_doc_dir, 'index.rst'), contents) # Fix issues in reference.rst/api.rst. for filename in ['reference.rst', 'api.rst']: reference = os.path.join(target_doc_dir, filename) if not os.path.exists(reference): continue with open(reference) as f: data = f.read() data = data.replace('std::ostream &', 'std::ostream&') data = re.sub(re.compile('doxygenfunction.. (bin|oct|hexu|hex)$', re.MULTILINE), r'doxygenfunction:: \1(int)', data) data = data.replace('std::FILE*', 'std::FILE *') data = data.replace('unsigned int', 'unsigned') with open(reference, 'w') as f: f.write(data) # Build the docs. html_dir = os.path.join(build_dir, 'html') if os.path.exists(html_dir): shutil.rmtree(html_dir) include_dir = fmt_repo.dir if LooseVersion(version) >= LooseVersion('3.0.0'): include_dir = os.path.join(include_dir, 'fmt') build.build_docs(version, doc_dir=target_doc_dir, include_dir=include_dir, work_dir=build_dir) # Create symlinks for older versions. for link, target in {'index': 'contents', 'api': 'reference'}.items(): link = os.path.join(html_dir, link) + '.html' target += '.html' if os.path.exists(os.path.join(html_dir, target)) and \ not os.path.exists(link): os.symlink(target, link) # Copy docs to the website. version_doc_dir = os.path.join(doc_repo.dir, version) shutil.rmtree(version_doc_dir) shutil.move(html_dir, version_doc_dir)