Skip to content

Commit

Permalink
update links due to folder name change
Browse files Browse the repository at this point in the history
  • Loading branch information
karlnapf committed Feb 22, 2016
1 parent 7bb6481 commit 6673433
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/cookbook/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This is achieved by the following high-level steps:

1. Use the automatically translated [API examples](https://github.com/shogun-toolbox/shogun/tree/feature/sphinxdoc/examples/meta/src/) in Shogun's meta example language. As these are part of our test process, they are guaranteed to be executable and errors (e.g. due to API changes) are easily caught.

2. [Cookbook pages](https://github.com/shogun-toolbox/shogun/tree/feature/sphinxdoc/doc/sphinx/source/examples/) contain text that uses snippets from the above code listings. Those are automatically extracted based on a simple markup system.
2. [Cookbook pages](https://github.com/shogun-toolbox/shogun/tree/feature/sphinxdoc/doc/cookbook/source/examples/) contain text that uses snippets from the above code listings. Those are automatically extracted based on a simple markup system.

3. Automatically build a static html page with a global tab for each of Shogun's target languages. The user can toggle the shown language of the snippets without switching the page itself.

Expand All @@ -16,7 +16,7 @@ To add an entry, only two files are needed:

* A meta language example, e.g. ```shogun/examples/meta/src/classifier/knn.sg``` (which during the build process is automatically translated to ```build/examples/python/classifier/knn.py```, ```build/examples/R/classifier/knn.R```, etc). The file should contain a number of snippet start and end markers, see for example [knn.sg](https://github.com/shogun-toolbox/shogun/blob/feature/sphinxdoc/examples/meta/src/classifier/knn.sg).

* A Sphinx markdown file with matching filename and directory, e.g. ```shogun/doc/sphinx/source/examples/classifier/knn.rst```. This file contains a description of the API example and references to code snippets. The point is to *not* show the full file listing but only a subset. The file should furthermore contain basic math in the form of LaTeX, important references (wikipedia, scientific paper references using BibTeX, etc), and links to the involved Shogun class documentation, github issues, etc. We use Sphinx tags to make this easy, see for example [knn.rst](https://github.com/shogun-toolbox/shogun/blob/feature/sphinxdoc/doc/sphinx/source/examples/classifier/knn.rst).
* A Sphinx markdown file with matching filename and directory, e.g. ```shogun/doc/sphinx/source/examples/classifier/knn.rst```. This file contains a description of the API example and references to code snippets. The point is to *not* show the full file listing but only a subset. The file should furthermore contain basic math in the form of LaTeX, important references (wikipedia, scientific paper references using BibTeX, etc), and links to the involved Shogun class documentation, github issues, etc. We use Sphinx tags to make this easy, see for example [knn.rst](https://github.com/shogun-toolbox/shogun/blob/feature/sphinxdoc/doc/cookbook/source/examples/classifier/knn.rst).

## Guidelines

Expand All @@ -28,7 +28,7 @@ To add an entry, only two files are needed:
## Some useful tips

* All external weblinks are automatically checked and warnings are given if corrupt, but please ensure you do not put in dead links.
* If you want to add a BibTeX reference, add it to [references.bib](https://github.com/shogun-toolbox/shogun/blob/feature/sphinxdoc/doc/sphinx/source/references.bib). Please do only use properly formated entries.
* If you want to add a BibTeX reference, add it to [references.bib](https://github.com/shogun-toolbox/shogun/blob/feature/sphinxdoc/doc/cookbook/source/references.bib). Please do only use properly formated entries.
* It is very easy to re-structure the main page, or to put in general overview pages (i.e. a general description of the Classification interface of Shogun). Feel free to do so.

### Where to start
Expand All @@ -44,7 +44,7 @@ This can be done as running
make doc
```

This generates a ```doc/sphinx/html``` folder in your build folder. To see the results, run
This generates a ```doc/cookbook/html``` folder in your build folder. To see the results, run

```
python -m SimpleHTTPServer
Expand Down

0 comments on commit 6673433

Please sign in to comment.