Skip to content

Commit

Permalink
yet another attempt: fixed documentation generation for windows
Browse files Browse the repository at this point in the history
  • Loading branch information
crohkohl committed Aug 7, 2015
1 parent 4009805 commit a4a8253
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 39 deletions.
14 changes: 7 additions & 7 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Methods: **GET**

Arguments: `job_id`

Location: [`digits/dataset/views.py@15`](..\digits/dataset/views.py#L15)
Location: [`digits/dataset/views.py@15`](../digits/dataset/views.py#L15)

### `/datasets/images/classification.json`

Expand All @@ -32,7 +32,7 @@ Location: [`digits/dataset/views.py@15`](..\digits/dataset/views.py#L15)
Methods: **POST**

Location: [`digits/dataset/images/classification/views.py@245`](..\digits/dataset/images/classification/views.py#L245)
Location: [`digits/dataset/images/classification/views.py@245`](../digits/dataset/images/classification/views.py#L245)

### `/index.json`

Expand All @@ -54,7 +54,7 @@ Location: [`digits/dataset/images/classification/views.py@245`](..\digits/datase
Methods: **GET**

Location: [`digits/views.py@23`](..\digits/views.py#L23)
Location: [`digits/views.py@23`](../digits/views.py#L23)

### `/models/<job_id>.json`

Expand All @@ -70,7 +70,7 @@ Methods: **GET**

Arguments: `job_id`

Location: [`digits/model/views.py@31`](..\digits/model/views.py#L31)
Location: [`digits/model/views.py@31`](../digits/model/views.py#L31)

### `/models/images/classification.json`

Expand All @@ -82,7 +82,7 @@ Location: [`digits/model/views.py@31`](..\digits/model/views.py#L31)
Methods: **POST**

Location: [`digits/model/images/classification/views.py@53`](..\digits/model/images/classification/views.py#L53)
Location: [`digits/model/images/classification/views.py@53`](../digits/model/images/classification/views.py#L53)

### `/models/images/classification/classify_many.json`

Expand All @@ -94,7 +94,7 @@ Location: [`digits/model/images/classification/views.py@53`](..\digits/model/ima
Methods: **POST**

Location: [`digits/model/images/classification/views.py@290`](..\digits/model/images/classification/views.py#L290)
Location: [`digits/model/images/classification/views.py@290`](../digits/model/images/classification/views.py#L290)

### `/models/images/classification/classify_one.json`

Expand All @@ -106,5 +106,5 @@ Location: [`digits/model/images/classification/views.py@290`](..\digits/model/im
Methods: **POST**

Location: [`digits/model/images/classification/views.py@236`](..\digits/model/images/classification/views.py#L236)
Location: [`digits/model/images/classification/views.py@236`](../digits/model/images/classification/views.py#L236)

62 changes: 31 additions & 31 deletions docs/FlaskRoutes.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ These are all technically RESTful, but they return HTML pages. To get JSON respo
Methods: **GET**

Location: [`digits/views.py@23`](..\digits/views.py#L23)
Location: [`digits/views.py@23`](../digits/views.py#L23)

## Jobs

Expand All @@ -48,7 +48,7 @@ Methods: **DELETE**

Arguments: `job_id`

Location: [`digits/views.py@139`](..\digits/views.py#L139)
Location: [`digits/views.py@139`](../digits/views.py#L139)

### `/datasets/<job_id>/abort`

Expand All @@ -58,7 +58,7 @@ Methods: **POST**

Arguments: `job_id`

Location: [`digits/views.py@159`](..\digits/views.py#L159)
Location: [`digits/views.py@159`](../digits/views.py#L159)

### `/datasets/<job_id>/status`

Expand All @@ -68,7 +68,7 @@ Methods: **GET**

Arguments: `job_id`

Location: [`digits/views.py@120`](..\digits/views.py#L120)
Location: [`digits/views.py@120`](../digits/views.py#L120)

### `/jobs/<job_id>`

Expand All @@ -78,7 +78,7 @@ Methods: **GET**

Arguments: `job_id`

Location: [`digits/views.py@87`](..\digits/views.py#L87)
Location: [`digits/views.py@87`](../digits/views.py#L87)

### `/jobs/<job_id>`

Expand All @@ -88,7 +88,7 @@ Methods: **PUT**

Arguments: `job_id`

Location: [`digits/views.py@104`](..\digits/views.py#L104)
Location: [`digits/views.py@104`](../digits/views.py#L104)

### `/jobs/<job_id>`

Expand All @@ -98,7 +98,7 @@ Methods: **DELETE**

Arguments: `job_id`

Location: [`digits/views.py@139`](..\digits/views.py#L139)
Location: [`digits/views.py@139`](../digits/views.py#L139)

### `/jobs/<job_id>/abort`

Expand All @@ -108,7 +108,7 @@ Methods: **POST**

Arguments: `job_id`

Location: [`digits/views.py@159`](..\digits/views.py#L159)
Location: [`digits/views.py@159`](../digits/views.py#L159)

### `/jobs/<job_id>/status`

Expand All @@ -118,7 +118,7 @@ Methods: **GET**

Arguments: `job_id`

Location: [`digits/views.py@120`](..\digits/views.py#L120)
Location: [`digits/views.py@120`](../digits/views.py#L120)

### `/models/<job_id>`

Expand All @@ -128,7 +128,7 @@ Methods: **DELETE**

Arguments: `job_id`

Location: [`digits/views.py@139`](..\digits/views.py#L139)
Location: [`digits/views.py@139`](../digits/views.py#L139)

### `/models/<job_id>/abort`

Expand All @@ -138,7 +138,7 @@ Methods: **POST**

Arguments: `job_id`

Location: [`digits/views.py@159`](..\digits/views.py#L159)
Location: [`digits/views.py@159`](../digits/views.py#L159)

### `/models/<job_id>/status`

Expand All @@ -148,7 +148,7 @@ Methods: **GET**

Arguments: `job_id`

Location: [`digits/views.py@120`](..\digits/views.py#L120)
Location: [`digits/views.py@120`](../digits/views.py#L120)

## Datasets

Expand All @@ -166,7 +166,7 @@ Methods: **GET**

Arguments: `job_id`

Location: [`digits/dataset/views.py@15`](..\digits/dataset/views.py#L15)
Location: [`digits/dataset/views.py@15`](../digits/dataset/views.py#L15)

### `/datasets/images/classification`

Expand All @@ -178,31 +178,31 @@ Location: [`digits/dataset/views.py@15`](..\digits/dataset/views.py#L15)
Methods: **POST**

Location: [`digits/dataset/images/classification/views.py@245`](..\digits/dataset/images/classification/views.py#L245)
Location: [`digits/dataset/images/classification/views.py@245`](../digits/dataset/images/classification/views.py#L245)

### `/datasets/images/classification/new`

> Returns a form for a new ImageClassificationDatasetJob
Methods: **GET**

Location: [`digits/dataset/images/classification/views.py@235`](..\digits/dataset/images/classification/views.py#L235)
Location: [`digits/dataset/images/classification/views.py@235`](../digits/dataset/images/classification/views.py#L235)

### `/datasets/images/resize-example`

> Resizes the example image, and returns it as a string of png data
Methods: **POST**

Location: [`digits/dataset/images/views.py@17`](..\digits/dataset/images/views.py#L17)
Location: [`digits/dataset/images/views.py@17`](../digits/dataset/images/views.py#L17)

### `/datasets/summary`

> Return a short HTML summary of a DatasetJob
Methods: **GET**

Location: [`digits/dataset/views.py@36`](..\digits/dataset/views.py#L36)
Location: [`digits/dataset/views.py@36`](../digits/dataset/views.py#L36)

## Models

Expand All @@ -220,7 +220,7 @@ Methods: **GET**

Arguments: `job_id`

Location: [`digits/model/views.py@31`](..\digits/model/views.py#L31)
Location: [`digits/model/views.py@31`](../digits/model/views.py#L31)

### `/models/<job_id>/download`

Expand All @@ -230,7 +230,7 @@ Methods: **GET**, **POST**

Arguments: `job_id`, `extension` (`tar.gz`)

Location: [`digits/model/views.py@158`](..\digits/model/views.py#L158)
Location: [`digits/model/views.py@158`](../digits/model/views.py#L158)

### `/models/<job_id>/download.<extension>`

Expand All @@ -240,15 +240,15 @@ Methods: **GET**, **POST**

Arguments: `job_id`, `extension`

Location: [`digits/model/views.py@158`](..\digits/model/views.py#L158)
Location: [`digits/model/views.py@158`](../digits/model/views.py#L158)

### `/models/customize`

> Returns a customized file for the ModelJob based on completed form fields
Methods: **POST**

Location: [`digits/model/views.py@53`](..\digits/model/views.py#L53)
Location: [`digits/model/views.py@53`](../digits/model/views.py#L53)

### `/models/images/classification`

Expand All @@ -260,7 +260,7 @@ Location: [`digits/model/views.py@53`](..\digits/model/views.py#L53)
Methods: **POST**

Location: [`digits/model/images/classification/views.py@53`](..\digits/model/images/classification/views.py#L53)
Location: [`digits/model/images/classification/views.py@53`](../digits/model/images/classification/views.py#L53)

### `/models/images/classification/classify_many`

Expand All @@ -272,7 +272,7 @@ Location: [`digits/model/images/classification/views.py@53`](..\digits/model/ima
Methods: **GET**, **POST**

Location: [`digits/model/images/classification/views.py@290`](..\digits/model/images/classification/views.py#L290)
Location: [`digits/model/images/classification/views.py@290`](../digits/model/images/classification/views.py#L290)

### `/models/images/classification/classify_one`

Expand All @@ -284,47 +284,47 @@ Location: [`digits/model/images/classification/views.py@290`](..\digits/model/im
Methods: **GET**, **POST**

Location: [`digits/model/images/classification/views.py@236`](..\digits/model/images/classification/views.py#L236)
Location: [`digits/model/images/classification/views.py@236`](../digits/model/images/classification/views.py#L236)

### `/models/images/classification/large_graph`

> Show the loss/accuracy graph, but bigger
Methods: **GET**

Location: [`digits/model/images/classification/views.py@225`](..\digits/model/images/classification/views.py#L225)
Location: [`digits/model/images/classification/views.py@225`](../digits/model/images/classification/views.py#L225)

### `/models/images/classification/new`

> Return a form for a new ImageClassificationModelJob
Methods: **GET**

Location: [`digits/model/images/classification/views.py@32`](..\digits/model/images/classification/views.py#L32)
Location: [`digits/model/images/classification/views.py@32`](../digits/model/images/classification/views.py#L32)

### `/models/images/classification/top_n`

> Classify many images and show the top N images per category by confidence
Methods: **POST**

Location: [`digits/model/images/classification/views.py@374`](..\digits/model/images/classification/views.py#L374)
Location: [`digits/model/images/classification/views.py@374`](../digits/model/images/classification/views.py#L374)

### `/models/visualize-lr`

> Returns a JSON object of data used to create the learning rate graph
Methods: **POST**

Location: [`digits/model/views.py@103`](..\digits/model/views.py#L103)
Location: [`digits/model/views.py@103`](../digits/model/views.py#L103)

### `/models/visualize-network`

> Returns a visualization of the custom network as a string of PNG data
Methods: **POST**

Location: [`digits/model/views.py@90`](..\digits/model/views.py#L90)
Location: [`digits/model/views.py@90`](../digits/model/views.py#L90)

## Util

Expand All @@ -334,7 +334,7 @@ Location: [`digits/model/views.py@90`](..\digits/model/views.py#L90)
Methods: **GET**

Location: [`digits/views.py@242`](..\digits/views.py#L242)
Location: [`digits/views.py@242`](../digits/views.py#L242)

### `/files/<path:path>`

Expand All @@ -350,5 +350,5 @@ Methods: **GET**

Arguments: `path`

Location: [`digits/views.py@217`](..\digits/views.py#L217)
Location: [`digits/views.py@217`](../digits/views.py#L217)

2 changes: 1 addition & 1 deletion scripts/generate_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ def _print_route(self, route):
filename = os.path.relpath(filename, digits_root).replace("\\","/")
self.w('Location: [`%s@%s`](%s#L%s)' % (
filename, route['location']['line'],
os.path.join('..', filename), route['location']['line'],
os.path.join('..', filename).replace("\\","/"), route['location']['line'],
))
self.w()

Expand Down

0 comments on commit a4a8253

Please sign in to comment.