diff --git a/sites/scrapy.org/docs/sources/_ext/scrapydocs.py b/sites/scrapy.org/docs/sources/_ext/scrapydocs.py new file mode 100644 index 000000000..8ae3a40f9 --- /dev/null +++ b/sites/scrapy.org/docs/sources/_ext/scrapydocs.py @@ -0,0 +1,6 @@ +def setup(app): + app.add_description_unit( + directivename = "setting", + rolename = "setting", + indextemplate = "pair: %s; setting", + ) diff --git a/sites/scrapy.org/docs/sources/conf.py b/sites/scrapy.org/docs/sources/conf.py index 797fda1e2..25ce8406e 100644 --- a/sites/scrapy.org/docs/sources/conf.py +++ b/sites/scrapy.org/docs/sources/conf.py @@ -16,14 +16,14 @@ import sys, os # If your extensions are in another directory, add it here. If the directory # is relative to the documentation root, use os.path.abspath to make it # absolute, like shown here. -#sys.path.append(os.path.abspath('.')) +sys.path.append(os.path.join(os.path.dirname(__file__), "_ext")) # General configuration # --------------------- # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = [] +extensions = ['scrapydocs'] # Add any paths that contain templates here, relative to this directory. templates_path = ['../templates/docs'] diff --git a/sites/scrapy.org/docs/sources/index.rst b/sites/scrapy.org/docs/sources/index.rst index 59a7898b1..a7ce9a7bf 100644 --- a/sites/scrapy.org/docs/sources/index.rst +++ b/sites/scrapy.org/docs/sources/index.rst @@ -13,3 +13,4 @@ Contents: scrapy_intro tutorial/index tutorial2/index + reference/index diff --git a/sites/scrapy.org/docs/sources/reference/index.rst b/sites/scrapy.org/docs/sources/reference/index.rst new file mode 100644 index 000000000..dfa26b813 --- /dev/null +++ b/sites/scrapy.org/docs/sources/reference/index.rst @@ -0,0 +1,6 @@ +Reference +========= + +.. toctree:: + + settings diff --git a/sites/scrapy.org/docs/sources/reference/settings.rst b/sites/scrapy.org/docs/sources/reference/settings.rst new file mode 100644 index 000000000..05e3e43a0 --- /dev/null +++ b/sites/scrapy.org/docs/sources/reference/settings.rst @@ -0,0 +1,73 @@ +Settings +======== + +.. setting:: ADAPTORS_DEBUG +.. setting:: BOT_NAME +.. setting:: BOT_VERSION +.. setting:: CACHE2_DIR +.. setting:: CACHE2_IGNORE_MISSING +.. setting:: CACHE2_SECTORIZE +.. setting:: CLOSEDOMAIN_NOTIFY +.. setting:: CLOSEDOMAIN_TIMEOUT +.. setting:: CLUSTER_LOGDIR +.. setting:: CLUSTER_MASTER_CACHEFILE +.. setting:: CLUSTER_MASTER_ENABLED +.. setting:: CLUSTER_MASTER_NODES +.. setting:: CLUSTER_MASTER_POLL_INTERVAL +.. setting:: CLUSTER_MASTER_PORT +.. setting:: CLUSTER_WORKER_ENABLED +.. setting:: CLUSTER_WORKER_MAXPROC +.. setting:: CLUSTER_WORKER_PORT +.. setting:: CLUSTER_WORKER_SVNWORKDIR +.. setting:: COMMANDS_MODULE +.. setting:: COMMANDS_SETTINGS_MODULE +.. setting:: DEFAULT_ITEM_CLASS +.. setting:: DEPTH_LIMIT +.. setting:: DEPTH_STATS +.. setting:: DOWNLOADER_MIDDLEWARES +.. setting:: DOWNLOADER_STATS +.. setting:: DOWNLOAD_TIMEOUT +.. setting:: ENABLED_SPIDERS_FILE +.. setting:: EXTENSIONS +.. setting:: GLOBAL_CLUSTER_SETTINGS +.. setting:: GROUPSETTINGS_ENABLED +.. setting:: GROUPSETTINGS_MODULE +.. setting:: ITEM_PIPELINES +.. setting:: MAIL_FROM +.. setting:: MAIL_HOST +.. setting:: MEMDEBUG_ENABLED +.. setting:: MEMDEBUG_NOTIFY +.. setting:: MEMUSAGE_ENABLED +.. setting:: MEMUSAGE_LIMIT_MB +.. setting:: MEMUSAGE_NOTIFY_MAIL +.. setting:: MEMUSAGE_REPORT +.. setting:: MEMUSAGE_WARNING_MB +.. setting:: MYSQL_CONNECTION_SETTINGS +.. setting:: NEWSPIDER_MODULE +.. setting:: REQUESTS_QUEUE_SIZE +.. setting:: SCHEDULER +.. setting:: SCHEDULER_ORDER +.. setting:: SHOVEITEM_CACHE_OPT +.. setting:: SHOVEITEM_CACHE_URI +.. setting:: SHOVEITEM_STORE_OPT +.. setting:: SHOVEITEM_STORE_URI +.. setting:: SPIDERPROFILER_ENABLED +.. setting:: SPIDER_MIDDLEWARES +.. setting:: SPIDER_MODULES +.. setting:: STATS_CLEANUP +.. setting:: STATS_DEBUG +.. setting:: STATS_ENABLED +.. setting:: STATS_WSPORT +.. setting:: STATS_WSTIMEOUT +.. setting:: TELNETCONSOLE_ENABLED +.. setting:: TELNETCONSOLE_PORT +.. setting:: TEMPLATES_DIR +.. setting:: URLLENGTH_LIMIT +.. setting:: USER_AGENT +.. setting:: WEBCONSOLE_ENABLED +.. setting:: WEBCONSOLE_LOGFILE +.. setting:: WEBCONSOLE_PORT +.. setting:: WS_CACHESIZE +.. setting:: WS_ENABLED +.. setting:: WS_PORT +.. setting:: WS_REDIRECTURL