diff options
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 30 |
1 files changed, 17 insertions, 13 deletions
diff --git a/docs/conf.py b/docs/conf.py index d1dca3c..7935b0b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# pep8 documentation build configuration file, created by +# pycodestyle documentation build configuration file, created by # sphinx-quickstart on Tue Aug 21 09:47:49 2012. # # This file is execfile()d with the current directory set to its @@ -44,20 +44,20 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'pep8' +project = u'pycodestyle' authors = u'Johann C. Rocholl, Florent Xicluna, Ian Lee' -copyright = u'2006-2014, %s' % (authors) +copyright = u'2006-2016, %s' % (authors) # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # -pep8_version = __import__('pep8').__version__.split('.') +pkg_version = __import__('pycodestyle').__version__.split('.') # The short X.Y version. -version = '.'.join(pep8_version[:2]) +version = '.'.join(pkg_version[:2]) # The full version, including alpha/beta/rc tags. -release = '.'.join(pep8_version) +release = '.'.join(pkg_version) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -99,7 +99,11 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # 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 @@ -128,7 +132,7 @@ html_theme = 'default' # 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 = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. @@ -172,7 +176,7 @@ html_static_path = ['_static'] #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'pep8doc' +htmlhelp_basename = 'pycodestyledoc' # -- Options for LaTeX output ------------------------------------------------- @@ -192,7 +196,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto/manual]). latex_documents = [ - ('index', 'pep8.tex', u'pep8 documentation', + ('index', 'pycodestyle.tex', u'pycodestyle documentation', authors, 'manual'), ] @@ -222,7 +226,7 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'pep8', u'pep8 documentation', + ('index', 'pycodestyle', u'pycodestyle documentation', [authors], 1) ] @@ -236,8 +240,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'pep8', u'pep8 documentation', authors, - 'pep8', 'One line description of project.', + ('index', 'pycodestyle', u'pycodestyle documentation', authors, + 'pycodestyle', 'One line description of project.', 'Miscellaneous'), ] |