Commit c6f0f339 authored by André Anjos's avatar André Anjos 💬

[scripts/ci] Clean-up extra sphinx file generation

parent 63c60735
Pipeline #30426 passed with stages
in 9 minutes and 7 seconds
......@@ -74,6 +74,13 @@ def is_stable(package, refname, tag, repodir):
return False
def comment_cleanup(lines):
"""Cleans-up comments and empty lines from textual data read from files"""
no_comments = [k.partition('#')[0].strip() for k in lines]
return [k for k in no_comments if k]
def read_packages(filename):
Return a python list of tuples (repository, branch), given a file containing
......@@ -81,15 +88,34 @@ def read_packages(filename):
# loads dirnames from order file (accepts # comments and empty lines)
packages = []
with open(filename, 'rt') as f:
for line in f:
line = line.partition('#')[0].strip()
if line:
if ',' in line: #user specified a branch
path, branch = [k.strip() for k in line.split(',', 1)]
packages.append((path, branch))
packages.append((line, 'master'))
lines = comment_cleanup(f.readlines())
packages = []
for line in lines:
if ',' in line: #user specified a branch
path, branch = [k.strip() for k in line.split(',', 1)]
packages.append((path, branch))
packages.append((line, 'master'))
return packages
def uniq(seq, idfun=None):
"""Very fast, order preserving uniq function"""
# order preserving
if idfun is None:
def idfun(x): return x
seen = {}
result = []
for item in seq:
marker = idfun(item)
# in old Python versions:
# if seen.has_key(marker)
# but in new ones:
if marker in seen: continue
seen[marker] = 1
return result
......@@ -14,7 +14,7 @@ from . import bdt
from ..deploy import deploy_conda_package, deploy_documentation
from import read_packages
from import read_packages, comment_cleanup, uniq
from ..log import verbosity_option, get_logger, echo_normal
logger = get_logger(__name__)
......@@ -697,24 +697,27 @@ def docs(ctx, requirement, dry_run):
# Copying the content from extra_intersphinx
extra_intersphinx_path = os.path.join(clone_to, "doc",
test_requirements_path = os.path.join(clone_to, "doc",
requirements_path = os.path.join(clone_to, "requirements.txt")
if os.path.exists(extra_intersphinx_path):
extra_intersphinx += open(extra_intersphinx_path).readlines()
with open(extra_intersphinx_path) as f:
extra_intersphinx += comment_cleanup(f.readlines())
test_requirements_path = os.path.join(clone_to, "doc",
if os.path.exists(test_requirements_path):
extra_intersphinx += open(test_requirements_path).readlines()
with open(test_requirements_path) as f:
extra_intersphinx += comment_cleanup(f.readliens())
requirements_path = os.path.join(clone_to, "requirements.txt")
if os.path.exists(requirements_path):
extra_intersphinx += open(requirements_path).readlines()
with open(requirements_path) as f:
extra_intersphinx += comment_cleanup(f.readlines())
nitpick_path = os.path.join(clone_to, "doc", "nitpick-exceptions.txt")
if os.path.exists(nitpick_path):
nitpick += open(nitpick_path).readlines()
with open(nitpick_path) as f:
nitpick += comment_cleanup(f.readlines())'Generating sphinx files...')'Generating (extra) sphinx files...')
# Making unique lists and removing all bob/beat references
if not dry_run:
......@@ -723,16 +726,16 @@ def docs(ctx, requirement, dry_run):
group = os.environ['CI_PROJECT_NAMESPACE']
extra_intersphinx = set([k.strip() for k in extra_intersphinx \
if not k.strip().startswith(group)])'Contents of "doc/extra-intersphinx.txt":\n%s',
data = '\n'.join(uniq(sorted(extra_intersphinx)))'Contents of "doc/extra-intersphinx.txt":\n%s', data)
with open(os.path.join(doc_path, 'extra-intersphinx.txt'), 'w') as f:
# nitpick exceptions'Contents of "doc/nitpick-exceptions.txt":\n%s',
with open(os.path.join(doc_path, "nitpick-exceptions.txt"), "w") as f:
f.writelines(set([k.strip() for k in nitpick]))
data = '\n'.join(uniq(sorted(nitpick)))'Contents of "doc/nitpick-exceptions.txt":\n%s', data)
with open(os.path.join(doc_path, 'nitpick-exceptions.txt'), 'w') as f:
f.write(data)'Building documentation...')
ctx.invoke(build, dry_run=dry_run)
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment