Extends setup.py with build_doc command (#410)

samaid · PokhodenkoSA · PokhodenkoSA · commit ecdd1fc9637a · 2019-12-24T20:51:03.000+03:00
* Extends setup.py with build_doc command * Update setup.py Synced with master * Improvements for #410 (#427) * Simplify _remove_cwd_from_syspath() * Remove `import sys` in setup.py * Update setup.py Co-authored-by: Sergey Pokhodenko <pokhodenko.s.a@gmail.com>
diff --git a/docs/source/buildscripts/sdc_build_doc.py b/docs/source/buildscripts/sdc_build_doc.py
@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+# *****************************************************************************
+# Copyright (c) 2019, Intel Corporation All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#     Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#
+#     Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions and the following disclaimer in the documentation
+#     and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *****************************************************************************
+
+import os
+import sys
+from setuptools import Command
+
+
+# Sphinx User's Documentation Build
+
+class SDCBuildDoc(Command):
+    description = 'Builds Intel SDC documentation'
+    user_options = [
+        ('format', 'f', 'Documentation output format (html, pdf)'),
+        ('doctype', 't', 'Documentation type (user, dev)'),
+    ]
+
+    @staticmethod
+    def _remove_cwd_from_syspath():
+        # Remove current working directory from PYTHONPATH to avoid importing SDC from sources vs.
+        # from installed SDC package
+        cwd = ['', '.', './', os.getcwd()]
+        sys.path = [p for p in sys.path if p not in cwd]
+
+    def initialize_options(self):
+        self.format = 'html'
+        self.doctype = 'user'
+
+    def finalize_options(self):
+        pass
+
+    def run(self):
+        self.sdc_build_doc_command.finalize_options()
+        self.sdc_build_doc_command.run()
+
+    def __init__(self, dist):
+        super(SDCBuildDoc, self).__init__(dist)
+        self.format = 'html'
+        self.doctype = 'user'
+        try:
+            from sphinx.setup_command import BuildDoc
+        except ImportError:
+            raise ImportError('Cannot import Sphinx. '
+                              'Sphinx is the expected dependency for Intel SDC documentation build')
+
+        self._remove_cwd_from_syspath()
+        self.sdc_build_doc_command = BuildDoc(dist)
+        self.sdc_build_doc_command.initialize_options()
+
+
+# Sphinx Developer's Documentation Build
+
+#class build_devdoc(build.build):
+#    description = "Build developer's documentation"
+#
+#    def run(self):
+#        spawn(['rm', '-rf', 'docs/_builddev'])
+#        spawn(['sphinx-build', '-b', 'html', '-d', 'docs/_builddev/docstrees',
+#               '-j1', 'docs/devsource', '-t', 'developer', 'docs/_builddev/html'])
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -121,7 +121,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 html_sidebars = {
    '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html', 'relations.html'],
diff --git a/setup.py b/setup.py
@@ -1,3 +1,4 @@
+﻿# -*- coding: utf-8 -*-
 # *****************************************************************************
 # Copyright (c) 2019, Intel Corporation All rights reserved.
 #
@@ -27,8 +28,7 @@
 from setuptools import setup, Extension, find_packages, Command
 import platform
 import os
-from distutils.command import build
-from distutils.spawn import spawn
+from docs.source.buildscripts.sdc_build_doc import SDCBuildDoc
 
 
 # Note we don't import Numpy at the toplevel, since setup.py
@@ -38,38 +38,15 @@
 #import copy
 import versioneer
 
+# String constants for Intel SDC project configuration
+SDC_NAME_STR = 'Intel® Scalable Dataframe Compiler'
+
 # Inject required options for extensions compiled against the Numpy
 # C API (include dirs, library dirs etc.)
 np_compile_args = np_misc.get_info('npymath')
 
 is_win = platform.system() == 'Windows'
 
-# Sphinx User's Documentation Build
-
-
-class build_doc(build.build):
-    description = "Build user's documentation"
-
-    def run(self):
-        spawn(['rm', '-rf', 'docs/_build', 'API_doc', 'docs/usersource/api/'])
-        spawn(['python', 'docs/rename_function.py'])
-        spawn(['sphinx-build', '-b', 'html', '-d', 'docs/_build/docstrees',
-               '-j1', 'docs/usersource', '-t', 'user', 'docs/_build/html'])
-        spawn(['python', 'docs/CleanRSTfiles.py'])
-        spawn(['sphinx-build', '-b', 'html', '-d', 'docs/_build/docstrees',
-               '-j1', 'docs/usersource', '-t', 'user', 'docs/_build/html'])
-
-# Sphinx Developer's Documentation Build
-
-
-class build_devdoc(build.build):
-    description = "Build developer's documentation"
-
-    def run(self):
-        spawn(['rm', '-rf', 'docs/_builddev'])
-        spawn(['sphinx-build', '-b', 'html', '-d', 'docs/_builddev/docstrees',
-               '-j1', 'docs/devsource', '-t', 'developer', 'docs/_builddev/html'])
-
 
 def readme():
     with open('README.rst', encoding='utf-8') as f:
@@ -268,14 +245,6 @@ def readme():
 if _has_opencv:
     _ext_mods.append(ext_cv_wrapper)
 
-# Custom build commands
-#
-# These commands extends standart setuptools build procedure
-#
-sdc_build_commands = versioneer.get_cmdclass()
-sdc_build_commands['build_doc'] = build_doc
-sdc_build_commands['build_devdoc'] = build_devdoc
-
 
 class style(Command):
     """ Command to check and adjust code style
@@ -394,11 +363,19 @@ def run(self):
             print("%s Style check passed" % self._result_marker)
 
 
+# Custom build commands
+#
+# These commands extend standard setuptools build procedure
+#
+sdc_build_commands = versioneer.get_cmdclass()
+sdc_build_commands['build_doc'] = SDCBuildDoc
 sdc_build_commands.update({'style': style})
+sdc_version = versioneer.get_version()
+sdc_release = 'Alpha ({})'.format(versioneer.get_version())
 
-setup(name='sdc',
-      version=versioneer.get_version(),
-      description='compiling Python code for clusters',
+setup(name=SDC_NAME_STR,
+      version=sdc_version,
+      description='Numba* extension for compiling Pandas* operations',
       long_description=readme(),
       classifiers=[
           "Development Status :: 2 - Pre-Alpha",
@@ -409,9 +386,9 @@ def run(self):
           "Topic :: Software Development :: Compilers",
           "Topic :: System :: Distributed Computing",
       ],
-      keywords='data analytics cluster',
+      keywords='data analytics distributed Pandas Numba',
       url='https://github.com/IntelPython/sdc',
-      author='Intel',
+      author='Intel Corporation',
       packages=find_packages(),
       package_data={'sdc.tests': ['*.bz2'], },
       install_requires=['numba'],
@@ -421,6 +398,5 @@ def run(self):
       entry_points={
           "numba_extensions": [
               "init = sdc:_init_extension",
-          ],
-      },
-)
+          ]},
+      )
