powerline/docs/source/conf.py

# vim:fileencoding=utf-8:noet
from __future__ import (unicode_literals, division, absolute_import, print_function)

import os
import sys


sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(os.getcwd()))))
sys.path.insert(0, os.path.abspath(os.getcwd()))

extensions = [
	'powerline_autodoc', 'powerline_automan',
	'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode',
]
source_suffix = '.rst'
master_doc = 'index'
project = 'Powerline'
version = 'beta'
release = 'beta'
exclude_patterns = ['_build']
pygments_style = 'sphinx'

html_theme = 'default'
html_static_path = ['_static']
html_show_copyright = False

latex_show_urls = 'footnote'
latex_elements = {
	'preamble': '''
		\\DeclareUnicodeCharacter{22EF}{$\\cdots$}   % Dots
		\\DeclareUnicodeCharacter{2665}{\\ding{170}} % Heart
		\\DeclareUnicodeCharacter{2746}{\\ding{105}} % Snow
		\\usepackage{pifont}
	''',
}

man_pages = []
for doc in os.listdir(os.path.join(os.path.dirname(__file__), 'commands')):
	if doc.endswith('.rst'):
		name = doc[:-4]
		module = 'powerline.commands.{0}'.format(name)
		get_argparser = __import__(str(module), fromlist=[str('get_argparser')]).get_argparser
		parser = get_argparser()
		description = parser.description
		man_pages.append([
			'commands/' + name,
			'powerline' if name == 'main' else 'powerline-' + name,
			description,
			'',
			1
		])

on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if not on_rtd:  # only import and set the theme if we’re building docs locally
	try:
		import sphinx_rtd_theme
		html_theme = 'sphinx_rtd_theme'
		html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
	except ImportError:
		pass

if on_rtd or html_theme == 'sphinx_rtd_theme':
	html_context = {
		'css_files': [
			'https://media.readthedocs.org/css/sphinx_rtd_theme.css',
			'https://media.readthedocs.org/css/readthedocs-doc-embed.css',
			'_static/css/theme_overrides.css',
		],
	}
-												Combine vim modelines and Python encoding declarations

Ref #314

											
										
										
											2013-03-11 10:40:09 +01:00
+								# vim:fileencoding=utf-8:noet
-												Unify imports

Now imports follow the following structure:

1. __future__ line: exactly one line allowed:

        from __future__ import (unicode_literals, division, absolute_import, print_function)

   (powerline.shell is the only exception due to problems with argparse).
2. Standard python library imports in a form `import X`.
3. Standard python library imports in a form `from X import Y`.
4. and 5. 2. and 3. for third-party (non-python and non-powerline imports).
6. 3. for powerline non-test imports.
7. and 8. 2. and 3. for powerline testing module imports.

Each list entry is separated by exactly one newline from another import. If
there is module docstring it goes between `# vim:` comment and `__future__`
import. So the structure containing all items is the following:

    #!/usr/bin/env python
    # vim:fileencoding=utf-8:noet

    '''Powerline super module'''

    import sys

    from argparse import ArgumentParser

    import psutil

    from colormath.color_diff import delta_e_cie2000

    from powerline.lib.unicode import u

    import tests.vim as vim_module

    from tests import TestCase

.

											
										
										
											2014-08-31 20:55:26 +02:00
+								from __future__ import (unicode_literals, division, absolute_import, print_function)
-												Add Sphinx docs skeleton

											
										
										
											2012-12-13 15:43:05 +01:00
-												Update sphinx configuration

											
										
										
											2013-02-08 17:32:23 +01:00
+								import os
 								import sys
-												Add Sphinx docs skeleton

											
										
										
											2012-12-13 15:43:05 +01:00
-												Unify imports

Now imports follow the following structure:

1. __future__ line: exactly one line allowed:

        from __future__ import (unicode_literals, division, absolute_import, print_function)

   (powerline.shell is the only exception due to problems with argparse).
2. Standard python library imports in a form `import X`.
3. Standard python library imports in a form `from X import Y`.
4. and 5. 2. and 3. for third-party (non-python and non-powerline imports).
6. 3. for powerline non-test imports.
7. and 8. 2. and 3. for powerline testing module imports.

Each list entry is separated by exactly one newline from another import. If
there is module docstring it goes between `# vim:` comment and `__future__`
import. So the structure containing all items is the following:

    #!/usr/bin/env python
    # vim:fileencoding=utf-8:noet

    '''Powerline super module'''

    import sys

    from argparse import ArgumentParser

    import psutil

    from colormath.color_diff import delta_e_cie2000

    from powerline.lib.unicode import u

    import tests.vim as vim_module

    from tests import TestCase

.

											
										
										
											2014-08-31 20:55:26 +02:00
-												Fix documentation for threaded segments

											
										
										
											2013-03-17 17:20:21 +01:00
+								sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(os.getcwd()))))
 								sys.path.insert(0, os.path.abspath(os.getcwd()))
-												Add Sphinx docs skeleton

											
										
										
											2012-12-13 15:43:05 +01:00
-												Add `man` documentation target

Fixes #1131

											
										
										
											2014-10-25 19:31:23 +02:00
+								extensions = [
 									'powerline_autodoc', 'powerline_automan',
 									'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode',
 								]
-												Add Sphinx docs skeleton

											
										
										
											2012-12-13 15:43:05 +01:00
+								source_suffix = '.rst'
 								master_doc = 'index'
-												Remove the only remaining reference to `u'` string prefix

											
										
										
											2014-09-14 12:28:52 +02:00
+								project = 'Powerline'
-												Update documentation and version

											
										
										
											2012-12-17 15:24:42 +01:00
+								version = 'beta'
 								release = 'beta'
-												Add Sphinx docs skeleton

											
										
										
											2012-12-13 15:43:05 +01:00
+								exclude_patterns = ['_build']
 								pygments_style = 'sphinx'
-												Fix latex build: make some unicode characters found in help work

											
										
										
											2014-10-12 17:37:15 +02:00
-												docs: Fix building the docs without RTD theme.

Signed-off-by: Andreas Schneider <asn@cryptomilk.org>

											
										
										
											2014-08-13 17:37:11 +02:00
+								html_theme = 'default'
-												Add Sphinx docs skeleton

											
										
										
											2012-12-13 15:43:05 +01:00
+								html_static_path = ['_static']
-												Use readthedocs theme for docs

											
										
										
											2014-01-25 16:20:06 +01:00
+								html_show_copyright = False
-												Fix latex build: make some unicode characters found in help work

											
										
										
											2014-10-12 17:37:15 +02:00
+								latex_show_urls = 'footnote'
 								latex_elements = {
 									'preamble': '''
 										\\DeclareUnicodeCharacter{22EF}{$\\cdots$}   % Dots
 										\\DeclareUnicodeCharacter{2665}{\\ding{170}} % Heart
 										\\DeclareUnicodeCharacter{2746}{\\ding{105}} % Snow
 										\\usepackage{pifont}
 									''',
 								}
-												Add `man` documentation target

Fixes #1131

											
										
										
											2014-10-25 19:31:23 +02:00
+								man_pages = []
 								for doc in os.listdir(os.path.join(os.path.dirname(__file__), 'commands')):
 									if doc.endswith('.rst'):
 										name = doc[:-4]
 										module = 'powerline.commands.{0}'.format(name)
 										get_argparser = __import__(str(module), fromlist=[str('get_argparser')]).get_argparser
 										parser = get_argparser()
 										description = parser.description
 										man_pages.append([
 											'commands/' + name,
 											'powerline' if name == 'main' else 'powerline-' + name,
 											description,
 											'',
 
 										])
-												Use readthedocs theme for docs

											
										
										
											2014-01-25 16:20:06 +01:00
+								on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
-												Replace all ASCII ' with Unicode ’ in comments and docstrings

											
										
										
											2014-09-20 15:48:15 +02:00
+								if not on_rtd:  # only import and set the theme if we’re building docs locally
-												Use readthedocs theme for docs

											
										
										
											2014-01-25 16:20:06 +01:00
+									try:
 										import sphinx_rtd_theme
 										html_theme = 'sphinx_rtd_theme'
 										html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 									except ImportError:
 										pass
-												Allow wrapping of RTD tables

											
										
										
											2015-01-09 14:52:01 +01:00
 								if on_rtd or html_theme == 'sphinx_rtd_theme':
 									html_context = {
 										'css_files': [
 											'https://media.readthedocs.org/css/sphinx_rtd_theme.css',
 											'https://media.readthedocs.org/css/readthedocs-doc-embed.css',
 											'_static/css/theme_overrides.css',
 										],
 									}