Skip to content

Commit

Permalink
Update documentation styling to match other quantstack projects
Browse files Browse the repository at this point in the history
  • Loading branch information
SylvainCorlay committed Apr 27, 2018
1 parent 190b562 commit f28a383
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
Reading and writing image, sound and npz file formats to and from xtensor data structures. <br>
[Try it live in the browser!](https://mybinder.org/v2/gh/QuantStack/xtensor-io/master?filepath=notebooks/demo.ipynb)


## Introduction

**xtensor-io is an early developer preview, and is not suitable for general usage yet. Features and implementation are subject to change.**
Expand Down Expand Up @@ -49,6 +48,19 @@ make
sudo make install
```

## Trying it online

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

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

## Documentation

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

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

## Usage

```cpp
Expand Down
36 changes: 36 additions & 0 deletions binder-logo.svg
Loading
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-io': '../xml' }
templates_path = ['_templates']
html_static_path = ['_static']
source_suffix = '.rst'
master_doc = 'index'
project = 'xtensor-io'
Expand Down

0 comments on commit f28a383

Please sign in to comment.