Skip to content

Commit

Permalink
fixing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Jaime Arias committed Apr 12, 2017
1 parent b6b5b05 commit 7288ef1
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/VMO_Score.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
VMO_Score package
====================
=================

.. autosummary::
:toctree: generated
Expand Down
23 changes: 10 additions & 13 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os
import sphinx_bootstrap_theme
# import sys
# import os
import sphinx_rtd_theme

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('..'))
# sys.path.insert(0, os.path.abspath('..'))

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

Expand Down Expand Up @@ -54,7 +54,7 @@

# General information about the project.
project = u'VMO-Score'
copyright = u'2016, Jaime Arias, Myriam Desainte-Catherine, and Shlomo Dubnov'
copyright = u'2017, Jaime Arias, Myriam Desainte-Catherine, and Shlomo Dubnov'
author = u'Jaime Arias, Myriam Desainte-Catherine, and Shlomo Dubnov'

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -117,22 +117,19 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'bootstrap'
html_theme = 'sphinx_rtd_theme'

# 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 = {
'bootswatch_theme': "simplex",
'navbar_site_name': "Packages",
'navbar_pagenav': True,
'navbar_pagenav_name': "Content",
'navbar_sidebarrel': False,
'source_link_position': "",
'collapse_navigation': False,
'display_version': False,
'navigation_depth': 3,
}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
Expand Down
1 change: 1 addition & 0 deletions requirements/ci.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
numpy>=1.11.0
scipy>=0.17.0
matplotlib>=1.5.1
future

# Packages for graphical interface
Pillow>=3.2.0
Expand Down
2 changes: 1 addition & 1 deletion requirements/development.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# Documentation
Sphinx==1.4
sphinx-bootstrap-theme==0.4.8
sphinx_rtd_theme
smartypants==1.8.6

# Lint
Expand Down

0 comments on commit 7288ef1

Please sign in to comment.