|
20 | 20 | # import sys |
21 | 21 | # sys.path.insert(0, os.path.abspath('.')) |
22 | 22 |
|
23 | | - |
24 | 23 | # -- General configuration ------------------------------------------------ |
25 | 24 |
|
26 | 25 | # If your documentation needs a minimal Sphinx version, state it here. |
|
76 | 75 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
77 | 76 | todo_include_todos = False |
78 | 77 |
|
79 | | - |
80 | 78 | # -- Options for HTML output ---------------------------------------------- |
81 | 79 |
|
82 | 80 | # The theme to use for HTML and HTML Help pages. See the documentation for |
83 | 81 | # a list of builtin themes. |
84 | 82 | # |
85 | 83 | html_theme = 'alabaster' |
| 84 | +html_logo = '_static/logo.png' |
86 | 85 |
|
87 | 86 | # Theme options are theme-specific and customize the look and feel of a theme |
88 | 87 | # further. For a list of options available for each theme, see the |
89 | 88 | # documentation. |
90 | 89 | # |
91 | | -# html_theme_options = {} |
| 90 | +html_theme_options = { |
| 91 | + 'show_powered_by': True, |
| 92 | + 'github_user': 'robphoenix', |
| 93 | + 'github_repo': 'diffios', |
| 94 | + 'github_banner': True, |
| 95 | + 'show_related': True, |
| 96 | + 'description': |
| 97 | + "Compare Cisco IOS configurations against a baseline template" |
| 98 | +} |
92 | 99 |
|
93 | 100 | # Add any paths that contain custom static files (such as style sheets) here, |
94 | 101 | # relative to this directory. They are copied after the builtin static files, |
95 | 102 | # so a file named "default.css" will overwrite the builtin "default.css". |
96 | 103 | html_static_path = ['_static'] |
97 | 104 |
|
98 | | - |
99 | 105 | # -- Options for HTMLHelp output ------------------------------------------ |
100 | 106 |
|
101 | 107 | # Output file base name for HTML help builder. |
102 | 108 | htmlhelp_basename = 'diffiosdoc' |
103 | 109 |
|
104 | | - |
105 | 110 | # -- Options for LaTeX output --------------------------------------------- |
106 | 111 |
|
107 | 112 | latex_elements = { |
|
125 | 130 | # Grouping the document tree into LaTeX files. List of tuples |
126 | 131 | # (source start file, target name, title, |
127 | 132 | # author, documentclass [howto, manual, or own class]). |
128 | | -latex_documents = [ |
129 | | - (master_doc, 'diffios.tex', u'diffios Documentation', |
130 | | - u'Rob Phoenix', 'manual'), |
131 | | -] |
132 | | - |
| 133 | +latex_documents = [(master_doc, 'diffios.tex', u'diffios Documentation', |
| 134 | + u'Rob Phoenix', 'manual')] |
133 | 135 |
|
134 | 136 | # -- Options for manual page output --------------------------------------- |
135 | 137 |
|
136 | 138 | # One entry per manual page. List of tuples |
137 | 139 | # (source start file, name, description, authors, manual section). |
138 | | -man_pages = [ |
139 | | - (master_doc, 'diffios', u'diffios Documentation', |
140 | | - [author], 1) |
141 | | -] |
142 | | - |
| 140 | +man_pages = [(master_doc, 'diffios', u'diffios Documentation', [author], 1)] |
143 | 141 |
|
144 | 142 | # -- Options for Texinfo output ------------------------------------------- |
145 | 143 |
|
146 | 144 | # Grouping the document tree into Texinfo files. List of tuples |
147 | 145 | # (source start file, target name, title, author, |
148 | 146 | # dir menu entry, description, category) |
149 | 147 | texinfo_documents = [ |
150 | | - (master_doc, 'diffios', u'diffios Documentation', |
151 | | - author, 'diffios', 'One line description of project.', |
152 | | - 'Miscellaneous'), |
| 148 | + (master_doc, 'diffios', u'diffios Documentation', author, 'diffios', |
| 149 | + 'One line description of project.', 'Miscellaneous'), |
153 | 150 | ] |
154 | | - |
155 | | - |
156 | | - |
0 commit comments