Skip to content
This repository was archived by the owner on Apr 29, 2018. It is now read-only.

Commit 82e11bf

Browse files
committed
add logo
1 parent 466f135 commit 82e11bf

File tree

5 files changed

+17
-23
lines changed

5 files changed

+17
-23
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![diffios Logo](/docs/source/_static/logo.png)
1+
![diffios Logo](/docs/_static/logo.png)
22

33

44
[![Travis](https://img.shields.io/travis/robphoenix/diffios.svg?style=flat-square)](https://travis-ci.org/robphoenix/diffios)

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
SPHINXPROJ = diffios
8-
SOURCEDIR = source
8+
SOURCEDIR =
99
BUILDDIR = _build
1010

1111
# Put it first so that "make" without argument is like "make help".
Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
# import sys
2121
# sys.path.insert(0, os.path.abspath('.'))
2222

23-
2423
# -- General configuration ------------------------------------------------
2524

2625
# If your documentation needs a minimal Sphinx version, state it here.
@@ -76,32 +75,38 @@
7675
# If true, `todo` and `todoList` produce output, else they produce nothing.
7776
todo_include_todos = False
7877

79-
8078
# -- Options for HTML output ----------------------------------------------
8179

8280
# The theme to use for HTML and HTML Help pages. See the documentation for
8381
# a list of builtin themes.
8482
#
8583
html_theme = 'alabaster'
84+
html_logo = '_static/logo.png'
8685

8786
# Theme options are theme-specific and customize the look and feel of a theme
8887
# further. For a list of options available for each theme, see the
8988
# documentation.
9089
#
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+
}
9299

93100
# Add any paths that contain custom static files (such as style sheets) here,
94101
# relative to this directory. They are copied after the builtin static files,
95102
# so a file named "default.css" will overwrite the builtin "default.css".
96103
html_static_path = ['_static']
97104

98-
99105
# -- Options for HTMLHelp output ------------------------------------------
100106

101107
# Output file base name for HTML help builder.
102108
htmlhelp_basename = 'diffiosdoc'
103109

104-
105110
# -- Options for LaTeX output ---------------------------------------------
106111

107112
latex_elements = {
@@ -125,32 +130,21 @@
125130
# Grouping the document tree into LaTeX files. List of tuples
126131
# (source start file, target name, title,
127132
# 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')]
133135

134136
# -- Options for manual page output ---------------------------------------
135137

136138
# One entry per manual page. List of tuples
137139
# (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)]
143141

144142
# -- Options for Texinfo output -------------------------------------------
145143

146144
# Grouping the document tree into Texinfo files. List of tuples
147145
# (source start file, target name, title, author,
148146
# dir menu entry, description, category)
149147
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'),
153150
]
154-
155-
156-
File renamed without changes.

0 commit comments

Comments
 (0)