diff --git a/docs/conf.py b/docs/conf.py index 2d22c6a64..dfbd96675 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -100,7 +100,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinx_rtd_theme' +#html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/experimental/index.rst b/docs/experimental/index.rst index 1c019c396..0621b4925 100644 --- a/docs/experimental/index.rst +++ b/docs/experimental/index.rst @@ -15,20 +15,3 @@ it's properly merged) . Use at your own risk. .. warning:: This documentation is a work in progress. Use at your own risk. - -Add commands using external libraries -------------------------------------- - -You can also add Scrapy commands from an external library by adding `scrapy.commands` section into entry_points in the `setup.py`. - -The following example adds `my_command` command:: - - from setuptools import setup, find_packages - - setup(name='scrapy-mymodule', - entry_points={ - 'scrapy.commands': [ - 'my_command=my_scrapy_module.commands:MyCommand', - ], - }, - ) diff --git a/docs/topics/commands.rst b/docs/topics/commands.rst index f1f79ce70..52c4fe446 100644 --- a/docs/topics/commands.rst +++ b/docs/topics/commands.rst @@ -511,3 +511,24 @@ Example:: COMMANDS_MODULE = 'mybot.commands' .. _Deploying your project: http://scrapyd.readthedocs.org/en/latest/deploy.html + +Register commands via setup.py entry points +------------------------------------------- + +.. note:: This is an experimental feature, use with caution. + +You can also add Scrapy commands from an external library by adding a +``scrapy.commands`` section in the entry points of the library ``setup.py`` +file. + +The following example adds ``my_command`` command:: + + from setuptools import setup, find_packages + + setup(name='scrapy-mymodule', + entry_points={ + 'scrapy.commands': [ + 'my_command=my_scrapy_module.commands:MyCommand', + ], + }, + )