Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove usage of project.documentation_type in tasks #4896

Merged
merged 7 commits into from
Jan 23, 2019
Merged

Remove usage of project.documentation_type in tasks #4896

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7c807bb
Remove usage of project.documentation_type in tasks
stsewd Nov 12, 2018
4afd086
Fix search command
stsewd Nov 12, 2018
f88a09b
Fix search again
stsewd Nov 12, 2018
3b00678
Tests
stsewd Nov 13, 2018
44f9f9c
Refactor
stsewd Nov 13, 2018
93d3e63
One more test
stsewd Nov 13, 2018
20c671f
Merge branch 'master' into remove-usage-of-project-doctype
stsewd Jan 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 56 additions & 53 deletions readthedocs/projects/tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -676,6 +676,7 @@ def update_app_instances(self, html=False, localmedia=False, search=False,
args=[
self.project.pk,
self.version.pk,
self.config.doctype,
],
kwargs=dict(
hostname=socket.gethostname(),
Expand Down Expand Up @@ -759,7 +760,9 @@ def build_docs_html(self):
broadcast(
type='app',
task=move_files,
args=[self.version.pk, socket.gethostname()],
args=[
self.version.pk, socket.gethostname(), self.config.doctype
],
kwargs=dict(html=True)
)
except socket.error:
Expand Down Expand Up @@ -828,7 +831,7 @@ def is_type_sphinx(self):

# Web tasks
@app.task(queue='web')
def sync_files(project_pk, version_pk, hostname=None, html=False,
def sync_files(project_pk, version_pk, doctype, hostname=None, html=False,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm passing only the doctype here rather than the whole config object, we only use the doctype, but if someone thinks it's useful passing the config I can change it.

localmedia=False, search=False, pdf=False, epub=False):
"""
Sync build artifacts to application instances.
Expand Down Expand Up @@ -857,6 +860,7 @@ def sync_files(project_pk, version_pk, hostname=None, html=False,
move_files(
version_pk,
hostname,
doctype,
html=html,
localmedia=localmedia,
search=search,
Expand All @@ -872,7 +876,7 @@ def sync_files(project_pk, version_pk, hostname=None, html=False,


@app.task(queue='web')
def move_files(version_pk, hostname, html=False, localmedia=False,
def move_files(version_pk, hostname, doctype, html=False, localmedia=False,
search=False, pdf=False, epub=False):
"""
Task to move built documentation to web servers.
Expand Down Expand Up @@ -902,63 +906,62 @@ def move_files(version_pk, hostname, html=False, localmedia=False,
if html:
from_path = version.project.artifact_path(
version=version.slug,
type_=version.project.documentation_type,
type_=doctype,
)
target = version.project.rtd_build_path(version.slug)
Syncer.copy(from_path, target, host=hostname)

if 'sphinx' in version.project.documentation_type:
if search:
from_path = version.project.artifact_path(
version=version.slug,
type_='sphinx_search',
)
to_path = version.project.get_production_media_path(
type_='json',
version_slug=version.slug,
include_file=False,
)
Syncer.copy(from_path, to_path, host=hostname)
if search:
stsewd marked this conversation as resolved.
Show resolved Hide resolved
from_path = version.project.artifact_path(
version=version.slug,
type_='sphinx_search',
)
to_path = version.project.get_production_media_path(
type_='json',
version_slug=version.slug,
include_file=False,
)
Syncer.copy(from_path, to_path, host=hostname)

if localmedia:
from_path = version.project.artifact_path(
version=version.slug,
type_='sphinx_localmedia',
)
to_path = version.project.get_production_media_path(
type_='htmlzip',
version_slug=version.slug,
include_file=False,
)
Syncer.copy(from_path, to_path, host=hostname)
if localmedia:
from_path = version.project.artifact_path(
version=version.slug,
type_='sphinx_localmedia',
)
to_path = version.project.get_production_media_path(
type_='htmlzip',
version_slug=version.slug,
include_file=False,
)
Syncer.copy(from_path, to_path, host=hostname)

# Always move PDF's because the return code lies.
if pdf:
from_path = version.project.artifact_path(
version=version.slug,
type_='sphinx_pdf',
)
to_path = version.project.get_production_media_path(
type_='pdf',
version_slug=version.slug,
include_file=False,
)
Syncer.copy(from_path, to_path, host=hostname)
if epub:
from_path = version.project.artifact_path(
version=version.slug,
type_='sphinx_epub',
)
to_path = version.project.get_production_media_path(
type_='epub',
version_slug=version.slug,
include_file=False,
)
Syncer.copy(from_path, to_path, host=hostname)
# Always move PDF's because the return code lies.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment looks outdated

if pdf:
from_path = version.project.artifact_path(
version=version.slug,
type_='sphinx_pdf',
)
to_path = version.project.get_production_media_path(
type_='pdf',
version_slug=version.slug,
include_file=False,
)
Syncer.copy(from_path, to_path, host=hostname)
if epub:
from_path = version.project.artifact_path(
version=version.slug,
type_='sphinx_epub',
)
to_path = version.project.get_production_media_path(
type_='epub',
version_slug=version.slug,
include_file=False,
)
Syncer.copy(from_path, to_path, host=hostname)


@app.task(queue='web')
def update_search(version_pk, commit, delete_non_commit_files=True):
def update_search(version_pk, commit, doctype, delete_non_commit_files=True):
"""
Task to update search indexes.

Expand All @@ -968,12 +971,12 @@ def update_search(version_pk, commit, delete_non_commit_files=True):
"""
version = Version.objects.get(pk=version_pk)

if 'sphinx' in version.project.documentation_type:
if 'sphinx' in doctype:
stsewd marked this conversation as resolved.
Show resolved Hide resolved
page_list = process_all_json_files(version, build_dir=False)
else:
log.debug(
'Unknown documentation type: %s',
version.project.documentation_type
doctype
)
return

Expand Down