Skip to content

Commit

Permalink
Bug 1413975 - Docs: Disable unused Sphinx extensions
Browse files Browse the repository at this point in the history
This means less to both install and run at build time, hopefully
speeding up the build and reducing the chance of races/locking issues.
  • Loading branch information
edmorley committed Nov 28, 2017
1 parent f16d33e commit 644b0d9
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 26 deletions.
20 changes: 0 additions & 20 deletions docs/conf.py
Expand Up @@ -12,33 +12,13 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import os
import sys

import sphinx_rtd_theme

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('..'))
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "treeherder.config.settings")

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinxcontrib.httpdomain',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand Down
7 changes: 1 addition & 6 deletions requirements/docs.txt
@@ -1,12 +1,7 @@
# Dependencies for building the documentation, intended to be used standalone
# since doc generation does not need all of the requirements in common.txt.
# These are intentionally not version-pinned & have implicit dependencies,
# since otherwise we play tug of war with the Read the Docs build process
# every time they update Sphinx versions. If this file were just for Read the
# Docs, we could omit the Sphinx entry since they provide it, however that
# would not help those who wish to build the docs locally.
# This file is used by Read the Docs, Travis and when building locally.

Sphinx==1.6.5
sphinx-autobuild==0.7.1
sphinx-rtd-theme==0.2.4
sphinxcontrib-httpdomain==1.5.0

0 comments on commit 644b0d9

Please sign in to comment.