Merge pull request #5723 from kc284/master

Tweaks to the API reference generator
xapi-project · Jun 21, 2024 · 4770d5e · 4770d5e
2 parents d6221e2 + cffd225
commit 4770d5e
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 28 deletions.
diff --git a/ocaml/idl/autogen/api-ref-autogen.md → ocaml/idl/autogen/management-api.md b/ocaml/idl/autogen/api-ref-autogen.md → ocaml/idl/autogen/management-api.md
@@ -5,4 +5,4 @@ Version **@xapi-version@**
 -  [Classes](@root@management-api/classes.html)
 -  [Relationships Between Classes](@root@management-api/relationships-between-classes.html)
 -  [Types](@root@management-api/types.html)
--  [ErrorHandling](@root@management-api/api-ref-autogen-errors.html)
+-  [ErrorHandling](@root@management-api/api-errors.html)
diff --git a/ocaml/idl/markdown_backend.ml b/ocaml/idl/markdown_backend.ml
@@ -525,7 +525,7 @@ let generate_errors () =
       ]
   in
   render_file
-    ("api_errors.mustache", "api-ref-autogen-errors.md")
+    ("api_errors.mustache", "api-errors.md")
     error_json templatesdir destdir
 
 let all api =

diff --git a/ocaml/idl/templates/api_errors.mustache b/ocaml/idl/templates/api_errors.mustache
@@ -1,7 +1,3 @@
----
- layout: doc
----
-
 # Error Handling
 
 When a low-level transport error occurs, or a request is malformed at the HTTP

diff --git a/ocaml/idl/templates/class.mustache b/ocaml/idl/templates/class.mustache
@@ -1,7 +1,3 @@
----
- layout: doc
----
-
 # Class: {{{class_name}}}
 {{#class_deprecated}}
 

diff --git a/ocaml/idl/templates/classes.mustache b/ocaml/idl/templates/classes.mustache
@@ -1,7 +1,3 @@
----
- layout: doc
----
-
 # Classes
 
 The following classes are defined:

diff --git a/ocaml/idl/templates/relationships.mustache b/ocaml/idl/templates/relationships.mustache
@@ -1,7 +1,3 @@
----
- layout: doc
----
-
 # Relationships Between Classes
 
 Fields that are bound together are shown in the following table:

diff --git a/ocaml/idl/templates/toc.mustache b/ocaml/idl/templates/toc.mustache
@@ -1,15 +1,15 @@
 - title: API Reference
-  url: @root@api-ref-autogen.html
+  url: @root@management-api.html
   subfolderlist:
     - title: Classes
       url: @root@management-api/classes.html
-{{#classes}}
-    - title: Class:{{{name}}}
-      url: @root@management-api/class-{{{name_lower}}}.html
-{{/classes}}
     - title: Relationships Between Classes
       url: @root@management-api/relationships-between-classes.html
     - title: Types
       url: @root@management-api/types.html
+{{#classes}}
+    - title: Class:{{{name}}}
+      url: @root@management-api/class-{{{name_lower}}}.html
+{{/classes}}
     - title: Error Handling
-      url: @root@management-api/api-ref-autogen-errors.html
+      url: @root@management-api/api-errors.html
diff --git a/ocaml/idl/templates/types.mustache b/ocaml/idl/templates/types.mustache
@@ -1,7 +1,3 @@
----
- layout: doc
----
-
 # Types
 
 ## Primitives