~ubuntu-branches/ubuntu/wily/python-oslo.serialization/wily-proposed

« back to all changes in this revision

Viewing changes to doc/source/conf.py

• browse files at revision 1
• compare with another revision
• download diff
• download tarball
• view history from revision 1

Show diffs side-by-side

added

removed

doc/source/conf.py

 

1

# -*- coding: utf-8 -*-

 

2

# Licensed under the Apache License, Version 2.0 (the "License");

 

3

# you may not use this file except in compliance with the License.

 

4

# You may obtain a copy of the License at

 

5

#

 

6

#    http://www.apache.org/licenses/LICENSE-2.0

 

7

#

 

8

# Unless required by applicable law or agreed to in writing, software

 

9

# distributed under the License is distributed on an "AS IS" BASIS,

 

10

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

 

11

# implied.

 

12

# See the License for the specific language governing permissions and

 

13

# limitations under the License.

 

14

 

 

15

import os

 

16

import sys

 

17

 

 

18

sys.path.insert(0, os.path.abspath('../..'))

 

19

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

 

20

 

 

21

# Add any Sphinx extension module names here, as strings. They can be

 

22

# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

 

23

extensions = [

 

24

    'sphinx.ext.autodoc',

 

25

    #'sphinx.ext.intersphinx',

 

26

    'oslosphinx'

 

27

]

 

28

 

 

29

# autodoc generation is a bit aggressive and a nuisance when doing heavy

 

30

# text edit cycles.

 

31

# execute "export SPHINX_DEBUG=1" in your terminal to disable

 

32

 

 

33

# The suffix of source filenames.

 

34

source_suffix = '.rst'

 

35

 

 

36

# The master toctree document.

 

37

master_doc = 'index'

 

38

 

 

39

# General information about the project.

 

40

project = u'oslo.serialization'

 

41

copyright = u'2014, OpenStack Foundation'

 

42

 

 

43

# If true, '()' will be appended to :func: etc. cross-reference text.

 

44

add_function_parentheses = True

 

45

 

 

46

# If true, the current module name will be prepended to all description

 

47

# unit titles (such as .. function::).

 

48

add_module_names = True

 

49

 

 

50

# The name of the Pygments (syntax highlighting) style to use.

 

51

pygments_style = 'sphinx'

 

52

 

 

53

# -- Options for HTML output --------------------------------------------------

 

54

 

 

55

# The theme to use for HTML and HTML Help pages.  Major themes that come with

 

56

# Sphinx are currently 'default' and 'sphinxdoc'.

 

57

# html_theme_path = ["."]

 

58

# html_theme = '_theme'

 

59

# html_static_path = ['static']

 

60

 

 

61

# Output file base name for HTML help builder.

 

62

htmlhelp_basename = '%sdoc' % project

 

63

 

 

64

# Grouping the document tree into LaTeX files. List of tuples

 

65

# (source start file, target name, title, author, documentclass

 

66

# [howto/manual]).

 

67

latex_documents = [

 

68

    ('index',

 

69

     '%s.tex' % project,

 

70

     u'%s Documentation' % project,

 

71

     u'OpenStack Foundation', 'manual'),

 

72

]

 

73

 

 

74

# Example configuration for intersphinx: refer to the Python standard library.

 

75

#intersphinx_mapping = {'http://docs.python.org/': None}

 

 

b'\\ No newline at end of file'

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1