Skip to content

Commit cf156c9

Browse files
committed
SWPROT-8953: docs: Use git describe --tag for generating zpc docs
For some reasons it was using an older annotated tag (RC0) I didnt investigate much, but I believe it prefer tags in branches (main) which is a good practice, If confirmed we can switch back to the default describe and enforce tags in branches. Origin: #35 Signed-off-by: Philippe Coval <philippe.coval@silabs.com>
1 parent 01bda7a commit cf156c9

File tree

1 file changed

+1
-5
lines changed

1 file changed

+1
-5
lines changed

scripts/build/build_documentation.py

+1-5
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
documentation_root = os.path.realpath(args.source)
3838
output_dir = os.path.realpath(args.output_dir)
3939

40-
sphinx_opt_version = subprocess.check_output(["git", "describe"], cwd=default_project_root, text=True).strip()
40+
sphinx_opt_version = subprocess.check_output(["git", "describe", "--tags"], cwd=default_project_root, text=True).strip()
4141

4242
print(f"Git Version string: {sphinx_opt_version}")
4343

@@ -56,11 +56,7 @@ def setup_doxygen_project(project_name, outdir):
5656
print("could not find " + doxygen)
5757

5858
# run sphinx builder
59-
setup_doxygen_project("doxygen_uic", output_dir)
60-
setup_doxygen_project("doxygen_zigpc", output_dir)
6159
setup_doxygen_project("doxygen_zpc", output_dir)
62-
setup_doxygen_project("doxygen_aox", output_dir)
63-
setup_doxygen_project("reference_ucl_mqtt", output_dir)
6460

6561
sphinx_build_cmd=f"sphinx-build -b {args.builder} -c {doc_dir} -D root_doc={root_doc} -D version={sphinx_opt_version} -D release={sphinx_opt_version} -d {doctree_dir} {documentation_root} {output_dir}"
6662

0 commit comments

Comments
 (0)