From 6c85803063dcaecaf1732400eeb76510ef4a0e71 Mon Sep 17 00:00:00 2001 From: hurtbadly Date: Sat, 4 Jan 2025 22:49:58 +0530 Subject: [PATCH 1/2] Docs work --- docs/make.jl | 4 +-- docs/src/index.md | 65 +++++++++++++++++++++++------------------------ 2 files changed, 34 insertions(+), 35 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index 0a6237f..b702e53 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -10,7 +10,7 @@ makedocs(; authors="Jakub-Mitura , Divyansh-Goyal and contributors", sitename="MedImages.jl", format=DocumenterVitepress.MarkdownVitepress( - repo="https://github.com/JuliaHealth/MedImage.jl", + repo="https://github.com/JuliaHealth/MedImages.jl", ), pages=[ "Home" => "index.md", @@ -25,4 +25,4 @@ deploydocs(; devbranch="main", branch="gh-pages", push_preview=true -) \ No newline at end of file +) diff --git a/docs/src/index.md b/docs/src/index.md index 63cdb05..daaca23 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,34 +1,33 @@ ```@docs -MedImages.string_intent -MedImages.Mode_mi -MedImages.calculate_inverse_44_matrix -MedImages.formulate_sto_xyz -MedImages.Image_type -MedImages.formulate_qto_xyz -MedImages.calculate_qfac -MedImages.interpolate_point -MedImages.Interpolator_enum -MedImages.get_pixel_data -MedImages.get_base_indicies_arr -MedImages.interpolate_my -MedImages.formulate_xform_string -MedImages.CoordinateTerms -MedImages.formulate_string -MedImages.cast_to_array_b_type -MedImages.Image_subtype -MedImages.check_sform_qform_similarity -MedImages.formulate_timing_scale_for_xyzt_time -MedImages.set_spacing_for_nifti_files -MedImages.resample_to_image -MedImages.scale_mi -MedImages.set_direction_for_nifti_file -MedImages.set_origin_for_nifti_file -MedImages.pad_mi -MedImages.unique_series_id_within_dicom_files -MedImages.formulate_nifti_image_struct -MedImages.formulate_header_data_dict -MedImages.formulate_spacing_scale_for_xyzt_space -MedImages.crop_mi -MedImages.scale -MedImages.translate_mi -``` \ No newline at end of file +MedImages.MedImage +MedImages.Utils.create_nii_from_medimage +MedImages.Load_and_save.load_image +MedImages.save_med_image +MedImages.Basic_transformations.crop_mi +MedImages.Basic_transformations.translate_mi +MedImages.Brute_force_orientation.brute_force_find_perm_rev +MedImages.Utils.interpolate_my +MedImages.Spatial_metadata_change.change_orientation +MedImages.Load_and_save.unique_series_id_within_dicom_files +MedImages.Resample_to_target.scale +MedImages.Basic_transformations.pad_mi +MedImages.Resample_to_target.resample_to_image +MedImages.Basic_transformations.computeIndexToPhysicalPointMatrices_Julia +MedImages.Basic_transformations.scale_mi +MedImages.Utils.cast_to_array_b_type +MedImages.Load_and_save.get_pixel_data +MedImages.Spatial_metadata_change.scale +MedImages.Utils.interpolate_point +MedImages.load_med_image +MedImages.Utils.get_base_indicies_arr +MedImages.MedImage_data_struct.Interpolator_enum +MedImages.MedImage_data_struct.Mode_mi +MedImages.MedImage_data_struct.Image_subtype +MedImages.MedImage_data_struct.current_device_enum +MedImages.MedImage_data_struct.Image_type +MedImages.MedImage_data_struct.CoordinateMajornessTerms +MedImages.MedImage_data_struct.Orientation_code +MedImages.MedImage_data_struct.CoordinateTerms +MedImages.Load_and_save.infer_modality +``` + From 5eec8f83f5125939e28fd938f8180acf89e48833 Mon Sep 17 00:00:00 2001 From: divital-coder Date: Sun, 5 Jan 2025 16:40:15 +0530 Subject: [PATCH 2/2] Documentation setup --- .github/workflows/docx.yml | 24 ++++++++++++++++++++++++ docs/make.jl | 28 +++++++++++++++------------- 2 files changed, 39 insertions(+), 13 deletions(-) create mode 100644 .github/workflows/docx.yml diff --git a/.github/workflows/docx.yml b/.github/workflows/docx.yml new file mode 100644 index 0000000..86f4123 --- /dev/null +++ b/.github/workflows/docx.yml @@ -0,0 +1,24 @@ +name: Documenter + +on: + push: + branches: + - main + tags: + - '*' + pull_request: + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: julia-actions/setup-julia@v1 + with: + version: '1.10' # Use the appropriate Julia version + - name: Install dependencies + run: julia --project=docs -e 'using Pkg; Pkg.instantiate()' + - name: Build and deploy + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GitHub automatically provides this + run: julia --project=docs docs/make.jl \ No newline at end of file diff --git a/docs/make.jl b/docs/make.jl index b702e53..726cf03 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -4,23 +4,25 @@ using DocumenterVitepress DocMeta.setdocmeta!(MedImages, :DocTestSetup, :(using MedImages); recursive=true) -makedocs(; - modules=[MedImages], - repo=Remotes.GitHub("JuliaHealth", "MedImage.jl"), - authors="Jakub-Mitura , Divyansh-Goyal and contributors", - sitename="MedImages.jl", - format=DocumenterVitepress.MarkdownVitepress( - repo="https://github.com/JuliaHealth/MedImages.jl", - ), - pages=[ - "Home" => "index.md", +pgs = [ "Home" => "index.md", "Tutorials" => "tutorials.md", "Contributing" => "contributing.md" - ], -) + ] + +fmt = DocumenterVitepress.MarkdownVitepress( + repo = "https://github.com/Juliahealth/MedImages.jl",) + +makedocs(; + modules=[MedImages], + repo=Remotes.GitHub("JuliaHealth", "MedImages.jl"), + authors="Jakub-Mitura , Divyansh-Goyal , Jan-Zubik and contributors", + sitename="MedImages.jl", + format=fmt, + pages=pgs + ) deploydocs(; - repo="github.com/JuliaHealth/MedImage.jl", + repo="github.com/JuliaHealth/MedImages.jl", target="build", # this is where Vitepress stores its output devbranch="main", branch="gh-pages",