Skip to content

Commit

Permalink
Homogenize documentation style
Browse files Browse the repository at this point in the history
  • Loading branch information
SylvainCorlay committed Apr 27, 2018
1 parent 9a3abde commit c1ce74e
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,19 @@ To build the tests or actually use `xtensor-blas`, you will need binaries for

which are also available on conda-forge.

## Trying it online

To try out xtensor-blas interactively in your web browser, just click on the binder
link:

[![Binder](binder-logo.svg)](https://mybinder.org/v2/gh/QuantStack/xtensor/0.15.6?filepath=notebooks/xtensor.ipynb)

## Documentation

To get started with using `xtensor-blas`, check out the full documentation

http://xtensor-blas.readthedocs.io/

## Dependency on `xtensor`

`xtensor-blas` depends on the `xtensor` package
Expand Down
36 changes: 36 additions & 0 deletions binder-logo.svg
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/source/_static/main_stylesheet.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.wy-nav-content{
max-width: 1000px;
margin: auto;
}
4 changes: 4 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,13 @@

html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

def setup(app):
app.add_stylesheet("main_stylesheet.css")

extensions = ['breathe']
breathe_projects = { 'xtensor-blas': '../xml' }
templates_path = ['_templates']
html_static_path = ['_static']
source_suffix = '.rst'
master_doc = 'index'
project = 'xtensor-blas'
Expand Down

0 comments on commit c1ce74e

Please sign in to comment.