https://github.com/iglesias/shogun_manual

A prototype for a maintainable Shogun web manual
https://github.com/iglesias/shogun_manual

Last synced: 24 days ago
JSON representation

A prototype for a maintainable Shogun web manual

• Host: GitHub
• URL: https://github.com/iglesias/shogun_manual
• Owner: iglesias
• License: mit
• Created: 2015-12-03T09:55:47.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-03T09:56:40.000Z (about 9 years ago)
• Last Synced: 2024-10-15T22:48:36.971Z (2 months ago)
• Language: Python
• Size: 217 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A new Shogun web manual

## aka minimal examples 2.0

We attempt to get documentation such as [sckit's](http://scikit-learn.org/stable/user_guide.html).

We showcase our main strength via allowing users to switch the target language of the code snippets with one click.

# Prototype

This is a system to replace our modular examples, while automatically generating a more pretty documentation around them.

We combine easy API examples with a pretty web-documentation where we showcase Shogun's main strength: multiple language bindings with the same syntax.

The idea is to write a two files ```source/examples/classifier/knn.rst``` and ```source/examples/code/knn.sg```, where we describe a method (see 1st file), and can include snippets from a meta-language example (see 2nd file). We then use Sphinx with a custom plugin to generate a pretty page that shows these examples with one tab for each language. Everything automatic!

Run

```

make preview

```

and then open your browser at ```localhost:8000``` to see the demo.