mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2025-02-25 18:55:21 -06:00
e2a173d393
This is a POC that shows building webpack through standard `setup.py` commands. Any call to `setup.py build` or `bdist` or `sdist` will trigger a Webpack build of the assets first. A non-zero exit code will halt the process. Also, moved the `npm run dev` command, which here is `python setup.py watch`, though there is perhaps something better here. There is already `python setup.py develop`, which has a separate function, so I don't want to collide there. Example output here: https://gist.github.com/agjohnson/cdaab364fe598daa7f3bef750cfb84dd Refs #797
142 lines
3.6 KiB
Python
142 lines
3.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""`sphinx_rtd_theme` lives on `Github`_.
|
|
|
|
.. _github: https://github.com/rtfd/sphinx_rtd_theme
|
|
|
|
"""
|
|
|
|
import subprocess
|
|
import distutils.cmd
|
|
import setuptools.command.build_py
|
|
from io import open
|
|
from setuptools import setup
|
|
|
|
|
|
class WebpackBuildCommand(setuptools.command.build_py.build_py):
|
|
|
|
"""Prefix Python build with Webpack asset build"""
|
|
|
|
def run(self):
|
|
subprocess.run(['webpack', '--config', 'webpack.prod.js'], check=True)
|
|
super().run()
|
|
|
|
|
|
class WebpackDevelopCommand(distutils.cmd.Command):
|
|
|
|
description = "Run Webpack dev server"
|
|
|
|
user_options = []
|
|
|
|
def initialize_options(self):
|
|
pass
|
|
|
|
def finalize_options(self):
|
|
pass
|
|
|
|
def run(self):
|
|
subprocess.run(
|
|
["webpack-dev-server", "--open", "--config", "webpack.dev.js"],
|
|
check=True
|
|
)
|
|
|
|
|
|
class UpdateTranslationsCommand(distutils.cmd.Command):
|
|
|
|
description = "Run all localization commands"
|
|
|
|
user_options = []
|
|
sub_commands = [
|
|
('extract_messages', None),
|
|
('update_catalog', None),
|
|
('transifex', None),
|
|
('compile_catalog', None),
|
|
]
|
|
|
|
def initialize_options(self):
|
|
pass
|
|
|
|
def finalize_options(self):
|
|
pass
|
|
|
|
def run(self):
|
|
for cmd_name in self.get_sub_commands():
|
|
self.run_command(cmd_name)
|
|
|
|
|
|
class TransifexCommand(distutils.cmd.Command):
|
|
|
|
description = "Update translation files through Transifex"
|
|
|
|
user_options = []
|
|
|
|
def initialize_options(self):
|
|
pass
|
|
|
|
def finalize_options(self):
|
|
pass
|
|
|
|
def run(self):
|
|
subprocess.run(['tx', 'push', '--source'], check=True)
|
|
subprocess.run(['tx', 'pull'], check=True)
|
|
|
|
|
|
setup(
|
|
name='sphinx_rtd_theme',
|
|
version='0.4.3.dev0',
|
|
url='https://github.com/rtfd/sphinx_rtd_theme/',
|
|
license='MIT',
|
|
author='Dave Snider, Read the Docs, Inc. & contributors',
|
|
author_email='dev@readthedocs.org',
|
|
description='Read the Docs theme for Sphinx',
|
|
long_description=open('README.rst', encoding='utf-8').read(),
|
|
cmdclass={
|
|
'update_translations': UpdateTranslationsCommand,
|
|
'transifex': TransifexCommand,
|
|
'build_py': WebpackBuildCommand,
|
|
'watch': WebpackDevelopCommand,
|
|
},
|
|
zip_safe=False,
|
|
packages=['sphinx_rtd_theme'],
|
|
package_data={'sphinx_rtd_theme': [
|
|
'theme.conf',
|
|
'*.html',
|
|
'static/css/*.css',
|
|
'static/js/*.js',
|
|
'static/fonts/*.*'
|
|
]},
|
|
include_package_data=True,
|
|
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
|
|
entry_points = {
|
|
'sphinx.html_themes': [
|
|
'sphinx_rtd_theme = sphinx_rtd_theme',
|
|
]
|
|
},
|
|
install_requires=[
|
|
'sphinx'
|
|
],
|
|
extras_require={
|
|
'dev': [
|
|
'transifex-client',
|
|
'sphinxcontrib-httpdomain',
|
|
],
|
|
},
|
|
classifiers=[
|
|
'Framework :: Sphinx',
|
|
'Framework :: Sphinx :: Theme',
|
|
'Development Status :: 5 - Production/Stable',
|
|
'License :: OSI Approved :: MIT License',
|
|
'Environment :: Console',
|
|
'Environment :: Web Environment',
|
|
'Intended Audience :: Developers',
|
|
'Programming Language :: Python :: 2.7',
|
|
'Programming Language :: Python :: 3',
|
|
'Programming Language :: Python :: 3.3',
|
|
'Programming Language :: Python :: 3.4',
|
|
'Programming Language :: Python :: 3.5',
|
|
'Programming Language :: Python :: 3.6',
|
|
'Operating System :: OS Independent',
|
|
'Topic :: Documentation',
|
|
'Topic :: Software Development :: Documentation',
|
|
],
|
|
)
|