Skip to content

Commit 4770d5e

Browse files
authored
Merge pull request #5723 from kc284/master
Tweaks to the API reference generator
2 parents d6221e2 + cffd225 commit 4770d5e

File tree

8 files changed

+8
-28
lines changed

8 files changed

+8
-28
lines changed

ocaml/idl/autogen/api-ref-autogen.md renamed to ocaml/idl/autogen/management-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ Version **@xapi-version@**
55
- [Classes](@root@management-api/classes.html)
66
- [Relationships Between Classes](@root@management-api/relationships-between-classes.html)
77
- [Types](@root@management-api/types.html)
8-
- [ErrorHandling](@root@management-api/api-ref-autogen-errors.html)
8+
- [ErrorHandling](@root@management-api/api-errors.html)

ocaml/idl/markdown_backend.ml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -525,7 +525,7 @@ let generate_errors () =
525525
]
526526
in
527527
render_file
528-
("api_errors.mustache", "api-ref-autogen-errors.md")
528+
("api_errors.mustache", "api-errors.md")
529529
error_json templatesdir destdir
530530

531531
let all api =

ocaml/idl/templates/api_errors.mustache

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
layout: doc
3-
---
4-
51
# Error Handling
62

73
When a low-level transport error occurs, or a request is malformed at the HTTP

ocaml/idl/templates/class.mustache

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
layout: doc
3-
---
4-
51
# Class: {{{class_name}}}
62
{{#class_deprecated}}
73

ocaml/idl/templates/classes.mustache

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
layout: doc
3-
---
4-
51
# Classes
62

73
The following classes are defined:

ocaml/idl/templates/relationships.mustache

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
layout: doc
3-
---
4-
51
# Relationships Between Classes
62

73
Fields that are bound together are shown in the following table:

ocaml/idl/templates/toc.mustache

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
- title: API Reference
2-
url: @root@api-ref-autogen.html
2+
url: @root@management-api.html
33
subfolderlist:
44
- title: Classes
55
url: @root@management-api/classes.html
6-
{{#classes}}
7-
- title: Class:{{{name}}}
8-
url: @root@management-api/class-{{{name_lower}}}.html
9-
{{/classes}}
106
- title: Relationships Between Classes
117
url: @root@management-api/relationships-between-classes.html
128
- title: Types
139
url: @root@management-api/types.html
10+
{{#classes}}
11+
- title: Class:{{{name}}}
12+
url: @root@management-api/class-{{{name_lower}}}.html
13+
{{/classes}}
1414
- title: Error Handling
15-
url: @root@management-api/api-ref-autogen-errors.html
15+
url: @root@management-api/api-errors.html

ocaml/idl/templates/types.mustache

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
layout: doc
3-
---
4-
51
# Types
62

73
## Primitives

0 commit comments

Comments
 (0)