Skip to content

Commit

Permalink
Tweaks for site
Browse files Browse the repository at this point in the history
  • Loading branch information
TomDonoghue committed Mar 19, 2020
1 parent 6264f7e commit bae3e5f
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,12 @@ with motivating examples of why we recommend parameterizing neural power spectra
with a step-by-step guide through the model and how to apply it
- [Examples](https://fooof-tools.github.io/fooof/auto_examples/index.html):
demonstrating example analyses and use cases, and other functionality
- [API listing](https://fooof-tools.github.io/fooof/api.html):
which lists all the code and functionality available in the module
- [API list](https://fooof-tools.github.io/fooof/api.html):
which lists and describes all the code and functionality available in the module
- [FAQ](https://fooof-tools.github.io/fooof/faq.html):
answering frequency asked questions
- [Glossary](https://fooof-tools.github.io/fooof/glossary.html):
which defines all the key terms used in the module
- [Reference](https://fooof-tools.github.io/fooof/reference.html):
with information for reporting on using and reference the module

Expand All @@ -62,9 +64,7 @@ There are also optional dependencies, which are not required for model fitting i
- [tqdm](https://github.com/tqdm/tqdm) is needed to print progress bars when fitting many models
- [pytest](https://github.com/pytest-dev/pytest) is needed to run the test suite locally

If you are using [Anaconda](https://www.anaconda.com/download/), then you are good to go.

If you aren't already using Anaconda, it is a useful tool to get and manage these dependencies.
We recommend using the [Anaconda](https://www.continuum.io/downloads) distribution to manage these requirements.

## Installation

Expand Down
1 change: 1 addition & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ clean:
rm -rf auto_tutorials
rm -rf auto_motivations
rm -rf generated
rm -rf backrefs

## make install:
# Build the html site, and push it to gh-pages branch of repo to deploy
Expand Down
5 changes: 5 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,11 @@
# The theme to use for HTML and HTML Help pages.
html_theme = 'bootstrap'

# Set the theme path explicitly
# This isn't always needed, but is useful so bulding docs doesn't fail on
# operating systems which don't have bootstrap on theme path
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()

# Theme options to customize the look and feel, which are theme-specific.
html_theme_options = {
'navbar_sidebarrel': False,
Expand Down

0 comments on commit bae3e5f

Please sign in to comment.