Skip to content

Commit e8a10b3

Browse files
Removing unused pdf/epub switches from project.tasks. The settings do now come from the Project.sphinx_enable_*_build flags.
1 parent 5fd9661 commit e8a10b3

File tree

2 files changed

+12
-28
lines changed

2 files changed

+12
-28
lines changed

readthedocs/projects/tasks.py

+12-16
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@
4848
@task(default_retry_delay=7 * 60, max_retries=5)
4949
@restoring_chdir
5050
def update_docs(pk, version_pk=None, build_pk=None, record=True, docker=False,
51-
pdf=True, epub=True,
5251
search=True, force=False, intersphinx=True, localmedia=True,
5352
api=None, basic=False, **kwargs):
5453
"""
@@ -110,7 +109,7 @@ def update_docs(pk, version_pk=None, build_pk=None, record=True, docker=False,
110109
results.update(setup_results)
111110

112111
record_build(api=api, build=build, record=record, results=results, state='building')
113-
build_results = build_docs(version, force, pdf, epub, search, localmedia)
112+
build_results = build_docs(version, force, search, localmedia)
114113
results.update(build_results)
115114

116115
except vcs_support_utils.LockTimeout, e:
@@ -143,8 +142,8 @@ def update_docs(pk, version_pk=None, build_pk=None, record=True, docker=False,
143142
html=results.get('html', [404])[0] == 0,
144143
localmedia=results.get('localmedia', [404])[0] == 0,
145144
search=results.get('search', [404])[0] == 0,
146-
pdf=True,
147-
epub=results.get('epub', [404])[0] == 0,
145+
pdf=version.project.sphinx_enable_pdf_build,
146+
epub=version.project.sphinx_enable_epub_build,
148147
)
149148

150149

@@ -184,14 +183,14 @@ def update_documentation_type(version, api):
184183
version.project.documentation_type = ret
185184

186185

187-
def docker_build(version, pdf=True, epub=True,
188-
search=True, force=False, intersphinx=True, localmedia=True):
186+
def docker_build(version, search=True, force=False, intersphinx=True,
187+
localmedia=True):
189188
"""
190189
The code that executes inside of docker
191190
"""
192191
environment_results = setup_environment(version)
193-
results = build_docs(version=version, force=force, pdf=pdf,
194-
epub=epub, search=search, localmedia=localmedia)
192+
results = build_docs(version=version, force=force, search=search,
193+
localmedia=localmedia)
195194
results.update(environment_results)
196195
return results
197196

@@ -395,15 +394,11 @@ def setup_environment(version):
395394

396395

397396
@task()
398-
def build_docs(version, force, pdf, epub, search, localmedia):
397+
def build_docs(version, force, search, localmedia):
399398
"""
400399
This handles the actual building of the documentation
401400
"""
402401

403-
# Arguments ``pdf``, ``epub``, arguments are currently
404-
# ignored. Besides HTML only builds for pdf/epub are supported but those
405-
# are configured in the project model.
406-
407402
project = version.project
408403
results = {}
409404

@@ -620,7 +615,8 @@ def record_pdf(api, record, results, state, version):
620615

621616

622617
@task(queue='web')
623-
def finish_build(version_pk, build_pk, hostname=None, html=False, localmedia=False, search=False, pdf=False, epub=False):
618+
def finish_build(version_pk, build_pk, hostname=None, html=False,
619+
localmedia=False, search=False, pdf=False, epub=False):
624620
"""
625621
Build Finished, do house keeping bits
626622
"""
@@ -850,7 +846,7 @@ def update_static_metadata(project_pk, path=None):
850846

851847

852848
#@periodic_task(run_every=crontab(hour="*", minute="*/5", day_of_week="*"))
853-
def update_docs_pull(record=False, pdf=False, force=False):
849+
def update_docs_pull(record=False, force=False):
854850
"""
855851
A high-level interface that will update all of the projects.
856852
@@ -859,7 +855,7 @@ def update_docs_pull(record=False, pdf=False, force=False):
859855
for version in Version.objects.filter(built=True):
860856
try:
861857
update_docs(
862-
pk=version.project.pk, version_pk=version.pk, record=record, pdf=pdf)
858+
pk=version.project.pk, version_pk=version.pk, record=record)
863859
except Exception, e:
864860
log.error("update_docs_pull failed", exc_info=True)
865861

readthedocs/rtd_tests/tests/test_builds.py

-12
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,6 @@ def test_build(self, mock_Popen, mock_api_versions, mock_chdir, mock_apiv2_downl
7474
with mock.patch('codecs.open', mock.mock_open(), create=True):
7575
with fake_paths(conf_path):
7676
built_docs = build_docs(version,
77-
False,
78-
False,
79-
False,
80-
False,
8177
False,
8278
False,
8379
False,
@@ -142,10 +138,6 @@ def test_build_respects_pdf_flag(self,
142138
with mock.patch('codecs.open', mock.mock_open(), create=True):
143139
with fake_paths(conf_path):
144140
built_docs = build_docs(version,
145-
False,
146-
False,
147-
False,
148-
False,
149141
False,
150142
False,
151143
False,
@@ -190,10 +182,6 @@ def test_build_respects_epub_flag(self,
190182
with mock.patch('codecs.open', mock.mock_open(), create=True):
191183
with fake_paths(conf_path):
192184
built_docs = build_docs(version,
193-
False,
194-
False,
195-
False,
196-
False,
197185
False,
198186
False,
199187
False,

0 commit comments

Comments
 (0)