From e48126265a1176ab02dfae472633e94869dfb4e5 Mon Sep 17 00:00:00 2001 From: Mateusz Jakub Fila <37295697+m-fila@users.noreply.github.com> Date: Tue, 12 Dec 2023 15:39:42 +0100 Subject: [PATCH] Dox fix (#244) * fixed broken contrib link in doxygen * fixed typos * fixed links to master/main branch * updated ReadmeLinks script with master/main change --- CMakeLists.txt | 5 ----- README.md | 31 +++++++++++++++---------------- doc/DoxygenLayout.xml | 2 +- doc/contributing.md | 2 +- scripts/updateReadmeLinks.py | 4 ++-- 5 files changed, 19 insertions(+), 25 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 5ff1f23e8..76dec8d5b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -73,11 +73,6 @@ endif() #--- target for Doxygen documentation ------------------------------------------ if(BUILD_DOCS) include(cmake/EDM4HEPDoxygen.cmake) - # 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}) endif() #--- add version files --------------------------------------------------------- diff --git a/README.md b/README.md index 3ba42ff95..14d4145c4 100644 --- a/README.md +++ b/README.md @@ -12,30 +12,30 @@ A generic event data model for future HEP collider experiments. | | | | |-|-|-| -| [Vector3f](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L11) | [Vector3d](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L26) | [Vector2i](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L42) | -| [Vector2f](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L56) | [TrackState](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L70) | [ObjectID](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L93) | -| [Quantity](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L105) | [Hypothesis](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L113) | [HitLevelData](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L120) | +| [Vector3f](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L11) | [Vector3d](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L26) | [Vector2i](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L42) | +| [Vector2f](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L56) | [TrackState](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L70) | [ObjectID](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L93) | +| [Quantity](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L105) | [Hypothesis](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L113) | [HitLevelData](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L120) | **Datatypes** | | | | |-|-|-| -| [EventHeader](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L130) | [MCParticle](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L140) | [SimTrackerHit](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L209) | -| [CaloHitContribution](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L243) | [SimCalorimeterHit](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L255) | [RawCalorimeterHit](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L267) | -| [CalorimeterHit](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L276) | [ParticleID](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L288) | [Cluster](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L301) | -| [TrackerHit](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L322) | [TrackerHitPlane](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L339) | [RawTimeSeries](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L360) | -| [Track](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L373) | [Vertex](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L392) | [ReconstructedParticle](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L409) | -| [SimPrimaryIonizationCluster](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L513) | [TrackerPulse](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L531) | [RecIonizationCluster](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L544) | -| [TimeSeries](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L555) | [RecDqdx](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L567) | | +| [EventHeader](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L130) | [MCParticle](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L140) | [SimTrackerHit](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L209) | +| [CaloHitContribution](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L243) | [SimCalorimeterHit](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L255) | [RawCalorimeterHit](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L267) | +| [CalorimeterHit](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L276) | [ParticleID](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L288) | [Cluster](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L301) | +| [TrackerHit](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L322) | [TrackerHitPlane](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L339) | [RawTimeSeries](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L360) | +| [Track](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L373) | [Vertex](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L392) | [ReconstructedParticle](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L409) | +| [SimPrimaryIonizationCluster](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L513) | [TrackerPulse](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L531) | [RecIonizationCluster](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L544) | +| [TimeSeries](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L555) | [RecDqdx](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L567) | | **Associations** | | | | |-|-|-| -| [MCRecoParticleAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L439) | [MCRecoCaloAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L448) | [MCRecoTrackerAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L457) | -| [MCRecoTrackerHitPlaneAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L466) | [MCRecoCaloParticleAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L475) | [MCRecoClusterParticleAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L484) | -| [MCRecoTrackParticleAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L493) | [RecoParticleVertexAssociation](https://github.com/key4hep/EDM4hep/blob/master/edm4hep.yaml#L502) | | +| [MCRecoParticleAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L439) | [MCRecoCaloAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L448) | [MCRecoTrackerAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L457) | +| [MCRecoTrackerHitPlaneAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L466) | [MCRecoCaloParticleAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L475) | [MCRecoClusterParticleAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L484) | +| [MCRecoTrackParticleAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L493) | [RecoParticleVertexAssociation](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L502) | | The tests and examples in the `tests` directory show how to read, write, and use these types in your code. @@ -74,7 +74,7 @@ The library files and dictionaries (`libedm4hep.so`, ...) must be put somewhere ## Python bindings There are python bindings for all the classes in the datamodel for working with -the clases individually (for working with collections podio has its own +the classes individually (for working with collections podio has its own bindings). Make sure that `/lib` is in `LD_LIBRARY_PATH`, `/python` is in `PYTHONPATH` and `/include` is in `ROOT_INCLUDE_PATH`: ```python @@ -129,5 +129,4 @@ of the input file should be part of the output. ## Contributing -Contributions and bug reports are welcome! See our [contributing -guidelines](./doc/contributing.md) if you want to contribute code to EDM4hep. +Contributions and bug reports are welcome! See our [contributing guidelines](doc/contributing.md) if you want to contribute code to EDM4hep. diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index 138bf38d8..dc7aad62e 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -5,7 +5,7 @@ - + diff --git a/doc/contributing.md b/doc/contributing.md index d2275ff7b..46fb52f8e 100644 --- a/doc/contributing.md +++ b/doc/contributing.md @@ -39,7 +39,7 @@ a PR, as we only allow *rebase merges* for PRs. git push downstream -- reload your own github website (https://github.com//EDM4HEP) +- reload your own Github website (https://github.com//EDM4HEP) - you should see your commit - now you can create a pull request on the web site diff --git a/scripts/updateReadmeLinks.py b/scripts/updateReadmeLinks.py index 72db2248c..86e431726 100755 --- a/scripts/updateReadmeLinks.py +++ b/scripts/updateReadmeLinks.py @@ -21,7 +21,7 @@ def check_readme_links(): links_are_ok = True for readme_line in readme_content: - edm4hep_objects = re.findall("\[(.*?)\]\(https:\/\/github.com\/key4hep\/EDM4hep\/blob\/master\/edm4hep\.yaml#L(\d+?)\)", readme_line) + edm4hep_objects = re.findall("\[(.*?)\]\(https:\/\/github.com\/key4hep\/EDM4hep\/blob\/main\/edm4hep\.yaml#L(\d+?)\)", readme_line) if edm4hep_objects: for edm4hep_object, original_line_number in edm4hep_objects: regex = f".*edm4hep::{edm4hep_object} *: *" @@ -32,7 +32,7 @@ def check_readme_links(): sys.exit(1) if edm4hep_yaml_line_numbers_with_match[0] != original_line_number: links_are_ok = False - 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_line = readme_line.replace(f"[{edm4hep_object}](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L{original_line_number})", f"[{edm4hep_object}](https://github.com/key4hep/EDM4hep/blob/main/edm4hep.yaml#L{edm4hep_yaml_line_numbers_with_match[0]})") print(f"{edm4hep_object} is wrongly linked (line {original_line_number} --> {edm4hep_yaml_line_numbers_with_match[0]})") new_readme_content += readme_line return links_are_ok, new_readme_content