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

New documentation #662

Merged
merged 3 commits into from
Jan 22, 2025
Merged

Conversation

axel-grc
Copy link
Collaborator

@axel-grc axel-grc commented Dec 20, 2024

Pull Request Summary

Documentation

  • Added the following documentation files:
    • CodeContribution.md
    • Geometry.md
    • Tutorial.md
    • CustomPhantom.sh
  • Added new forbild files:
    • Geometries_forbild.txt.sha512
    • SheppLogan_forbild.txt.sha512
  • Added examples from old documentation:
    • ForwardProjection
    • RayBoxIntersection
    • WaterPreCorrection
    • ConjugateGradient
    • 4DRooster
    • AmsterdamShroud
    • DaubechiesWaveletsRegularizedReconstruction
    • ElektaReconstruction
    • MotionCompensationReconstruction
    • TotalVariationRegularizedReconstruction
    • VarianReconstruction
  • Removed rtkThreeDCircularProjectionGeometry.dox from Doxygen to integrate it into Sphinx.

To Do

[x] Verify and replace references to Doxygen Geometry documentation with links to the Sphinx Geometry documentation (Axel puis Simon)
[x ] Modernize the code for WaterPreCorrection (Simon)
[x] Add result images to the examples
[x] Integrate the FanBeam 2D example from the old documentation into the ConjugateGradient example (Axel)
[x ] Redirect to the new doc on the old doc website

@SimonRit SimonRit added this to the RTK 2.7 milestone Jan 6, 2025
@SimonRit
Copy link
Collaborator

SimonRit commented Jan 6, 2025

Fixes #642 and #643

@axel-grc axel-grc force-pushed the new-documentation branch 3 times, most recently from 3b4560b to 8b71694 Compare January 6, 2025 17:34
@SimonRit SimonRit self-requested a review January 22, 2025 08:55
Copy link
Collaborator

@SimonRit SimonRit left a comment

Choose a reason for hiding this comment

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

This is a good start but it will need improvements for readability

@SimonRit SimonRit merged commit 96e7b8c into RTKConsortium:master Jan 22, 2025
20 checks passed
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.

2 participants