From 728c8dce245a4df095e5acab42db769d79efd1ba Mon Sep 17 00:00:00 2001 From: Xavier Claessens Date: Tue, 28 Mar 2023 10:53:55 -0400 Subject: doc: Use better name for builtin/return object title The title is used only in the sidebar. There is no need to have "extends" information there. For returned objects the actual name is not meaningful so it's better to use the long name. For builtin objects the name is important because that's the global variable name. --- docs/refman/generatormd.py | 1 + docs/refman/templates/object.mustache | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/refman/generatormd.py b/docs/refman/generatormd.py index 97230340e..6029016cf 100644 --- a/docs/refman/generatormd.py +++ b/docs/refman/generatormd.py @@ -281,6 +281,7 @@ class GeneratorMD(GeneratorBase): def _write_object(self, obj: Object) -> None: data = { 'name': obj.name, + 'title': obj.long_name if obj.obj_type == ObjectType.RETURNED else obj.name, 'description': obj.description, 'notes': obj.notes, 'warnings': obj.warnings, diff --git a/docs/refman/templates/object.mustache b/docs/refman/templates/object.mustache index ec86034e8..3b6c67950 100644 --- a/docs/refman/templates/object.mustache +++ b/docs/refman/templates/object.mustache @@ -1,6 +1,6 @@ --- short-description: "{{obj_type_name}} object: {{long_name}}" -title: {{name}}{{#extends}} (extends {{.}}){{/extends}} +title: {{title}} render-subpages: false ... # {{long_name}} (`{{name}}`{{#extends}} extends [[@{{.}}]]{{/extends}}) -- cgit v1.2.3