Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dox fix #244

Merged
merged 4 commits into from
Dec 12, 2023
Merged

Dox fix #244

merged 4 commits into from
Dec 12, 2023

Conversation

m-fila
Copy link
Contributor

@m-fila m-fila commented Dec 12, 2023

BEGINRELEASENOTES

  • Fixed typos and links in documentation and doxygen

ENDRELEASENOTES

@tmadlener
Copy link
Contributor

Very nice thank you. To avoid overwriting the main bits with master again. Could you also adapt the script that checks and fixes the links to the yaml file here

edm4hep_objects = re.findall("\[(.*?)\]\(https:\/\/github.com\/key4hep\/EDM4hep\/blob\/master\/edm4hep\.yaml#L(\d+?)\)", readme_line)

and here

readme_line = readme_line.replace(f"[{edm4hep_object}](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L{original_line_number})", f"[{edm4hep_object}](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L{edm4hep_yaml_line_numbers_with_match[0]})")

README.md Outdated Show resolved Hide resolved
undo master/main change to link to podio
@m-fila
Copy link
Contributor Author

m-fila commented Dec 12, 2023

Very nice thank you. To avoid overwriting the main bits with master again. Could you also adapt the script that checks and fixes the links to the yaml file here

edm4hep_objects = re.findall("\[(.*?)\]\(https:\/\/github.com\/key4hep\/EDM4hep\/blob\/master\/edm4hep\.yaml#L(\d+?)\)", readme_line)

and here

readme_line = readme_line.replace(f"[{edm4hep_object}](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L{original_line_number})", f"[{edm4hep_object}](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L{edm4hep_yaml_line_numbers_with_match[0]})")

Done

scripts/updateReadmeLinks.py Outdated Show resolved Hide resolved
Comment on lines -76 to -80
# copy images needed for documentation to build folder and install them
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doc/edm4hep_diagram.svg
${CMAKE_CURRENT_BINARY_DIR}/doxygen/html/doc/edm4hep_diagram.svg COPYONLY)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html/doc/edm4hep_diagram.svg
DESTINATION ${CMAKE_INSTALL_DOCDIR})
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not make the edm4hep diagram disappear on the main page?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe not because it uses the README which has a link to it but I haven't tested it

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doxygen copies the file on its own when generating html from md. Some older version perhaps required manual intervention

$ find build -name edm4hep_diagram.svg
build/doxygen/html/edm4hep_diagram.svg
$ find InstallArea/ -name edm4hep_diagram.svg
InstallArea/share/doc/EDM4HEP/doxygen/doxygen/html/edm4hep_diagram.svg

@tmadlener tmadlener merged commit e481262 into key4hep:main Dec 12, 2023
8 of 9 checks passed
@m-fila m-fila deleted the dox_fix branch May 23, 2024 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants