Skip to content

Commit

Permalink
touching up docs with new templates
Browse files Browse the repository at this point in the history
  • Loading branch information
lockefox committed Aug 7, 2017
1 parent e790cdb commit 41cbb89
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 7 deletions.
27 changes: 21 additions & 6 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import os
import sys
sys.path.insert(0, os.path.abspath('../prosper'))

import alabaster

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

Expand All @@ -40,10 +40,11 @@
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages']
'sphinx.ext.githubpages',
'alabaster']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ['templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
Expand Down Expand Up @@ -92,26 +93,40 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme_path = [alabaster.get_path()]
html_theme = 'alabaster'

# 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
# documentation.
#
# html_theme_options = {}
html_theme_options = {
'logo': 'logo-colour-sm.png',
'description': 'Common Utilities for Prosper Projects',
'description_font_style': 'italic',
'github_user': 'eveprosper',
'github_repo': 'prospercommon',
'github_banner': True,
#'donate_url': 'https://www.patreon.com/eveprosper',
}

# 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']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html',]
'index': [
'about.html', 'patreon.html', 'searchbox.html',
],
'**': [
'globaltoc.html', 'sourcelink.html', 'searchbox.html'
]
}
#html_sidebars = {
# '**': [
Expand Down
2 changes: 1 addition & 1 deletion docs/prosper_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ProsperConfig()
===============

.. code-block:: python
:linenos:
import prosper.common.prosper_config as p_config
ConfigObj = ProsperConfig(
Expand Down
Binary file added docs/static/logo-colour-sm.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions docs/templates/patreon.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<h3>Support Us</h3>
<ul>
<li><a href="https://www.patreon.com/bePatron?u=572110" data-patreon-widget-type="become-patron-button">Support EVEProsper On Patreon</a><script async src="https://c6.patreon.com/becomePatronButton.bundle.js"></script></li>
</ul>

0 comments on commit 41cbb89

Please sign in to comment.