Skip to content

Commit

Permalink
Use correct page-titles on Doxygen-created files. Fixes raspberrypi#2810
Browse files Browse the repository at this point in the history
  • Loading branch information
lurch committed Mar 6, 2023
1 parent 321bbd0 commit 153abfd
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 16 deletions.
3 changes: 2 additions & 1 deletion build.ninja
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
DOCUMENTATION_IMAGES_DIR = documentation/images
GITHUB_EDIT_TEMPLATE = jekyll-assets/_includes/github_edit.adoc
HTACCESS_EXTRA = documentation/htaccess_extra.txt
DOXYGEN_PICOSDK_INDEX_JSON = documentation/asciidoc/pico-sdk/picosdk_index.json

# this corresponds to BUILD_DIR in Makefile
builddir = build
Expand All @@ -21,7 +22,7 @@ rule create_build_adoc
command = $scripts_dir/create_build_adoc.py $documentation_index $site_config $GITHUB_EDIT_TEMPLATE $in $inc_dir $out

rule create_build_adoc_doxygen
command = $scripts_dir/create_build_adoc_doxygen.py $documentation_index $site_config $in $out_dir $out
command = $scripts_dir/create_build_adoc_doxygen.py $documentation_index $site_config $in $DOXYGEN_PICOSDK_INDEX_JSON $out_dir $out

rule create_build_adoc_include
command = $scripts_dir/create_build_adoc_include.py $site_config $GITHUB_EDIT_TEMPLATE $in $out
Expand Down
2 changes: 1 addition & 1 deletion scripts/create_auto_ninjabuild.py
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ def add_entire_directory(tab_dir, dir_path, pages_set, src_images, dest_images):

dest = os.path.join('$out_dir', page)
source = os.path.join('$src_dir', page)
extra_sources = ['$scripts_dir/create_build_adoc_doxygen.py', '$documentation_index', '$site_config']
extra_sources = ['$scripts_dir/create_build_adoc_doxygen.py', '$documentation_index', '$site_config', '$DOXYGEN_PICOSDK_INDEX_JSON']
if source not in all_doc_sources:
all_doc_sources.append(source)
ninja.build(dest, 'create_build_adoc_doxygen', source, extra_sources)
Expand Down
3 changes: 0 additions & 3 deletions scripts/create_build_adoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,6 @@ def check_no_markdown(filename):
break
if index_title is not None:
break
elif 'from_json' in tab:
index_title = tab['title']
break
if index_title is None:
raise Exception("Couldn't find title for {} in {}".format(os.path.join(output_subdir, adoc_filename), index_json))

Expand Down
23 changes: 12 additions & 11 deletions scripts/create_build_adoc_doxygen.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,27 +26,28 @@ def check_no_markdown(filename):
index_json = sys.argv[1]
config_yaml = sys.argv[2]
src_adoc = sys.argv[3]
includes_dir = sys.argv[4]
build_adoc = sys.argv[5]
picosdk_json = sys.argv[4]
includes_dir = sys.argv[5]
build_adoc = sys.argv[6]

output_subdir = os.path.basename(os.path.dirname(build_adoc))
adoc_filename = os.path.basename(build_adoc)

check_no_markdown(src_adoc)

with open(picosdk_json) as json_fh:
picosdk_data = json.load(json_fh)

index_title = None
with open(index_json) as json_fh:
data = json.load(json_fh)
for tab in data['tabs']:
if 'path' in tab and tab['path'] == output_subdir:
for subitem in tab['subitems']:
if 'subpath' in subitem and subitem['subpath'] == adoc_filename:
index_title = subitem['title']
break
if index_title is not None:
break
elif 'from_json' in tab:
index_title = tab['title']
if 'from_json' in tab and 'directory' in tab and tab['directory'] == output_subdir:
filebase = os.path.splitext(adoc_filename)[0]
if filebase in picosdk_data:
index_title = picosdk_data[filebase]['name']
else:
index_title = filebase
break
if index_title is None:
raise Exception("Couldn't find title for {} in {}".format(os.path.join(output_subdir, adoc_filename), index_json))
Expand Down

0 comments on commit 153abfd

Please sign in to comment.