EbookFoundation
/
readthedocs.org
mirror of https://github.com/EbookFoundation/readthedocs.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Resolve linting messages in readthedocs.doc_builder.*

build-pdf-ret-val
Gregor Müllegger 2015-07-31 13:43:06 +02:00
parent 593b812540
commit 6c65964ba5
5 changed files with 44 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
readthedocs/doc_builder/backends/mkdocs.py
View File

@ -23,7 +23,9 @@ class BaseMkdocs(BaseBuilder):
def __init__(self, *args, **kwargs):
super(BaseMkdocs, self).__init__(*args, **kwargs)
self.old_artifact_path = os.path.join(self.version.project.checkout_path(self.version.slug), self.build_dir)
self.old_artifact_path = os.path.join(
self.version.project.checkout_path(self.version.slug),
self.build_dir)
def append_conf(self, **kwargs):
"""
@ -46,34 +48,34 @@ class BaseMkdocs(BaseBuilder):
# Set mkdocs config values
MEDIA_URL = getattr(settings, 'MEDIA_URL', 'https://media.readthedocs.org')
media_url = getattr(settings, 'MEDIA_URL', 'https://media.readthedocs.org')
# Mkdocs needs a full domain here because it tries to link to local media files
if not MEDIA_URL.startswith('http'):
MEDIA_URL = 'http://localhost:8000' + MEDIA_URL
if not media_url.startswith('http'):
media_url = 'http://localhost:8000' + media_url
if 'extra_javascript' in user_config:
user_config['extra_javascript'].append('readthedocs-data.js')
user_config['extra_javascript'].append(
'readthedocs-dynamic-include.js')
user_config['extra_javascript'].append(
'%sjavascript/readthedocs-doc-embed.js' % MEDIA_URL)
'%sjavascript/readthedocs-doc-embed.js' % media_url)
else:
user_config['extra_javascript'] = [
'readthedocs-data.js',
'readthedocs-dynamic-include.js',
'%sjavascript/readthedocs-doc-embed.js' % MEDIA_URL,
'%sjavascript/readthedocs-doc-embed.js' % media_url,
]
if 'extra_css' in user_config:
user_config['extra_css'].append(
'%s/css/badge_only.css' % MEDIA_URL)
'%s/css/badge_only.css' % media_url)
user_config['extra_css'].append(
'%s/css/readthedocs-doc-embed.css' % MEDIA_URL)
'%s/css/readthedocs-doc-embed.css' % media_url)
else:
user_config['extra_css'] = [
'%scss/badge_only.css' % MEDIA_URL,
'%scss/readthedocs-doc-embed.css' % MEDIA_URL,
'%scss/badge_only.css' % media_url,
'%scss/readthedocs-doc-embed.css' % media_url,
]
# Set our custom theme dir for mkdocs
@ -84,7 +86,8 @@ class BaseMkdocs(BaseBuilder):
# RTD javascript writing
READTHEDOCS_DATA = {
# Will be available in the JavaScript as READTHEDOCS_DATA.
readthedocs_data = {
'project': self.version.project.slug,
'version': self.version.verbose_name,
'language': self.version.project.language,
@ -96,12 +99,12 @@ class BaseMkdocs(BaseBuilder):
'api_host': getattr(settings, 'SLUMBER_API_HOST', 'https://readthedocs.org'),
'commit': self.version.project.vcs_repo(self.version.slug).commit,
}
data_json = json.dumps(READTHEDOCS_DATA, indent=4)
data_json = json.dumps(readthedocs_data, indent=4)
data_ctx = Context({
'data_json': data_json,
'current_version': READTHEDOCS_DATA['version'],
'slug': READTHEDOCS_DATA['project'],
'html_theme': READTHEDOCS_DATA['theme'],
'current_version': readthedocs_data['version'],
'slug': readthedocs_data['project'],
'html_theme': readthedocs_data['theme'],
'pagename': None,
})
data_string = template_loader.get_template(
@ -127,14 +130,16 @@ class BaseMkdocs(BaseBuilder):
@restoring_chdir
def build(self, **kwargs):
checkout_path = self.version.project.checkout_path(self.version.slug)
#site_path = os.path.join(checkout_path, 'site')
# site_path = os.path.join(checkout_path, 'site')
os.chdir(checkout_path)
# Actual build
build_command = "{command} {builder} --clean --site-dir={build_dir} --theme=readthedocs".format(
command=self.version.project.venv_bin(version=self.version.slug, bin='mkdocs'),
builder=self.builder,
build_dir=self.build_dir,
)
build_command = (
"{command} {builder} --clean --site-dir={build_dir} --theme=readthedocs"
.format(
command=self.version.project.venv_bin(version=self.version.slug, bin='mkdocs'),
builder=self.builder,
build_dir=self.build_dir,
))
results = run(build_command, shell=True)
return results

14
readthedocs/doc_builder/backends/sphinx.py
View File

@ -32,7 +32,9 @@ class BaseSphinx(BaseBuilder):
def __init__(self, *args, **kwargs):
super(BaseSphinx, self).__init__(*args, **kwargs)
try:
self.old_artifact_path = os.path.join(self.version.project.conf_dir(self.version.slug), self.sphinx_build_dir)
self.old_artifact_path = os.path.join(
self.version.project.conf_dir(self.version.slug),
self.sphinx_build_dir)
except ProjectImportError:
docs_dir = self.docs_dir()
self.old_artifact_path = os.path.join(docs_dir, self.sphinx_build_dir)
@ -72,11 +74,13 @@ class BaseSphinx(BaseBuilder):
conf_py_path = self.version.get_conf_py_path()
remote_version = self.version.get_vcs_slug()
github_user, github_repo = version_utils.get_github_username_repo(url=self.version.project.repo)
github_user, github_repo = version_utils.get_github_username_repo(
url=self.version.project.repo)
github_version_is_editable = (self.version.type == 'branch')
display_github = github_user is not None
bitbucket_user, bitbucket_repo = version_utils.get_bitbucket_username_repo(url=self.version.project.repo)
bitbucket_user, bitbucket_repo = version_utils.get_bitbucket_username_repo(
url=self.version.project.repo)
bitbucket_version_is_editable = (self.version.type == 'branch')
display_bitbucket = bitbucket_user is not None
@ -261,7 +265,9 @@ class PdfBuilder(BaseSphinx):
os.makedirs(self.target)
exact = os.path.join(self.old_artifact_path, "%s.pdf" % self.version.project.slug)
exact_upper = os.path.join(self.old_artifact_path, "%s.pdf" % self.version.project.slug.capitalize())
exact_upper = os.path.join(
self.old_artifact_path,
"%s.pdf" % self.version.project.slug.capitalize())
if self.pdf_file_name and os.path.exists(self.pdf_file_name):
from_file = self.pdf_file_name

3
readthedocs/doc_builder/base.py
View File

@ -97,7 +97,8 @@ class BaseBuilder(object):
if not os.path.exists(index_filename):
readme_filename = os.path.join(docs_dir, 'README.{ext}'.format(ext=extension))
if os.path.exists(readme_filename):
os.system('mv {readme} {index}'.format(index=index_filename, readme=readme_filename))
os.system('mv {readme} {index}'.format(index=index_filename,
readme=readme_filename))
else:
index_file = open(index_filename, 'w+')
index_text = """

1
readthedocs/doc_builder/environments.py
View File

@ -12,7 +12,6 @@ from django.utils.text import slugify
from django.conf import settings
from rest_framework.renderers import JSONRenderer
from readthedocs.projects.utils import run
from readthedocs.restapi.serializers import VersionFullSerializer
log = logging.getLogger(__name__)

8
readthedocs/doc_builder/loader.py
View File

@ -2,8 +2,12 @@ from django.utils.importlib import import_module
from django.conf import settings
# Managers
mkdocs = import_module(getattr(settings, 'MKDOCS_BACKEND', 'readthedocs.doc_builder.backends.mkdocs'))
sphinx = import_module(getattr(settings, 'SPHINX_BACKEND', 'readthedocs.doc_builder.backends.sphinx'))
mkdocs = import_module(
getattr(settings, 'MKDOCS_BACKEND',
'readthedocs.doc_builder.backends.mkdocs'))
sphinx = import_module(
getattr(settings, 'SPHINX_BACKEND',
'readthedocs.doc_builder.backends.sphinx'))
BUILDER_BY_NAME = {
# Possible HTML Builders