Renaming sphinx_enable_*_build fields to enable_*_build.

Author: gregmuellegger

readthedocs/projects/forms.py

@@ -141,8 +141,8 @@ class Meta:
             'conf_py_file',
             'default_branch',
             'default_version',
-            'sphinx_enable_pdf_build',
-            'sphinx_enable_epub_build',
+            'enable_pdf_build',
+            'enable_epub_build',
             # Privacy
             'privacy_level',
             # 'version_privacy_level',

readthedocs/projects/migrations/0045_add_format_build_options.py

@@ -8,23 +8,23 @@
 class Migration(SchemaMigration):
 
     def forwards(self, orm):
-        # Adding field 'Project.sphinx_enable_epub_build'
-        db.add_column(u'projects_project', 'sphinx_enable_epub_build',
+        # Adding field 'Project.enable_epub_build'
+        db.add_column(u'projects_project', 'enable_epub_build',
                       self.gf('django.db.models.fields.BooleanField')(default=True),
                       keep_default=False)
 
-        # Adding field 'Project.sphinx_enable_pdf_build'
-        db.add_column(u'projects_project', 'sphinx_enable_pdf_build',
+        # Adding field 'Project.enable_pdf_build'
+        db.add_column(u'projects_project', 'enable_pdf_build',
                       self.gf('django.db.models.fields.BooleanField')(default=True),
                       keep_default=False)
 
 
     def backwards(self, orm):
-        # Deleting field 'Project.sphinx_enable_epub_build'
-        db.delete_column(u'projects_project', 'sphinx_enable_epub_build')
+        # Deleting field 'Project.enable_epub_build'
+        db.delete_column(u'projects_project', 'enable_epub_build')
 
-        # Deleting field 'Project.sphinx_enable_pdf_build'
-        db.delete_column(u'projects_project', 'sphinx_enable_pdf_build')
+        # Deleting field 'Project.enable_pdf_build'
+        db.delete_column(u'projects_project', 'enable_pdf_build')
 
 
     models = {
@@ -132,8 +132,8 @@ def backwards(self, orm):
             'single_version': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
             'skip': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
             'slug': ('django.db.models.fields.SlugField', [], {'unique': 'True', 'max_length': '255'}),
-            'sphinx_enable_epub_build': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
-            'sphinx_enable_pdf_build': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'enable_epub_build': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
+            'enable_pdf_build': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
             'suffix': ('django.db.models.fields.CharField', [], {'default': "'.rst'", 'max_length': '10'}),
             'theme': ('django.db.models.fields.CharField', [], {'default': "'default'", 'max_length': '20'}),
             'use_system_packages': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
@@ -156,4 +156,4 @@ def backwards(self, orm):
         }
     }
 
-    complete_apps = ['projects']
+    complete_apps = ['projects']

readthedocs/projects/models.py

@@ -114,11 +114,11 @@ class Project(models.Model):
                     "This may slow down your page loads."))
 
     # Sphinx specific build options.
-    sphinx_enable_epub_build = models.BooleanField(
+    enable_epub_build = models.BooleanField(
         _('Enable EPUB build'), default=True,
         help_text=_(
             'Create a EPUB version of your documentation with each build.'))
-    sphinx_enable_pdf_build = models.BooleanField(
+    enable_pdf_build = models.BooleanField(
         _('Enable PDF build'), default=True,
         help_text=_(
             'Create a PDF version of your documentation with each build.'))

readthedocs/projects/tasks.py

@@ -142,8 +142,8 @@ def update_docs(pk, version_pk=None, build_pk=None, record=True, docker=False,
             html=results.get('html', [404])[0] == 0,
             localmedia=results.get('localmedia', [404])[0] == 0,
             search=results.get('search', [404])[0] == 0,
-            pdf=version.project.sphinx_enable_pdf_build,
-            epub=version.project.sphinx_enable_epub_build,
+            pdf=version.project.enable_pdf_build,
+            epub=version.project.enable_epub_build,
         )
 
 
@@ -463,15 +463,15 @@ def build_docs(version, force, search, localmedia):
 
             # Optional build steps
             if version.project.slug not in HTML_ONLY and not project.skip:
-                if project.sphinx_enable_pdf_build:
+                if project.enable_pdf_build:
                     pdf_builder = get_builder_class('sphinx_pdf')(version)
                     results['pdf'] = pdf_builder.build()
                     # Always move pdf results even when there's an error.
                     # if pdf_results[0] == 0:
                     pdf_builder.move()
                 else:
                     results['pdf'] = fake_results
-                if project.sphinx_enable_epub_build:
+                if project.enable_epub_build:
                     epub_builder = get_builder_class('sphinx_epub')(version)
                     results['epub'] = epub_builder.build()
                     if results['epub'][0] == 0:
@@ -574,7 +574,7 @@ def record_build(api, record, build, results, state, start_time=None):
 def record_pdf(api, record, results, state, version):
     if not record or 'sphinx' not in version.project.documentation_type:
         return None
-    if not version.project.sphinx_enable_pdf_build:
+    if not version.project.enable_pdf_build:
         return None
     try:
         if 'pdf' in results:

readthedocs/rtd_tests/tests/test_builds.py

@@ -128,8 +128,8 @@ def test_build_respects_pdf_flag(self,
         mock_Popen.side_effect = build_subprocess_side_effect
 
         project = ProjectFactory(
-            sphinx_enable_pdf_build=True,
-            sphinx_enable_epub_build=False)
+            enable_pdf_build=True,
+            enable_epub_build=False)
         version = project.versions.all()[0]
 
         conf_path = os.path.join(project.checkout_path(version.slug), project.conf_py_file)
@@ -172,8 +172,8 @@ def test_build_respects_epub_flag(self,
         mock_Popen.side_effect = build_subprocess_side_effect
 
         project = ProjectFactory(
-            sphinx_enable_pdf_build=False,
-            sphinx_enable_epub_build=True)
+            enable_pdf_build=False,
+            enable_epub_build=True)
         version = project.versions.all()[0]
 
         conf_path = os.path.join(project.checkout_path(version.slug), project.conf_py_file)