OSIPI / TF2.4_IVIM-MRI_CodeCollection

OSIPI TF2.4: IVIM MRI code collection
Apache License 2.0
9 stars 27 forks source link

Generate API documentation using Sphinx. #59

Closed AhmedBasem20 closed 5 months ago

AhmedBasem20 commented 5 months ago

Describe the changes you have made in this PR

Implemented automated API documentation generation using Sphinx and Github Actions. This process involves two steps:

  1. Executing sphinx-apidoc -o doc src to generate initial API documentation into doc folder after extracting docs from src folder.
  2. Running make html to generate HTML documentation in the doc/_build/html folder.

This setup allows for including manual documentation alongside API documentation. I'll try to integrate the markdown files from the doc folder onto the documentation page. And exclude the src/original file as it doesn't have much documentation there.

Documentation Link

https://ahmedbasem20.github.io/TF2.4_IVIM-MRI_CodeCollection

Link this PR to an issue [optional]

Fixes #50

AhmedBasem20 commented 5 months ago

Hi @etpeterson, please check the website again and let me know what you think: https://ahmedbasem20.github.io/TF2.4_IVIM-MRI_CodeCollection We now have a main page that points to the algorithm analysis figures and the API documentation.

I used this action https://github.com/dawidd6/action-download-artifact to get the Figures artifact uploaded by the analysis.yml workflow. And then included it in the docs. This solution supersedes #49 .

etpeterson commented 5 months ago

This is looking good. I think it's ready. I just want to confirm with @oliverchampion and @petravanhoudt that we're putting documentation in the right place.

I'm thinking the other PR, should go in first and double check that, then this can be integrated. Is that the order you'd prefer @AhmedBasem20?

AhmedBasem20 commented 5 months ago

@etpeterson this pull request should replace #49, as we already generate the figures here but inside the sphinx theme.

etpeterson commented 5 months ago

@etpeterson this pull request should replace #49, as we already generate the figures here but inside the sphinx theme.

Ah, I see. Ok, close the other one. Let's give a few more days to suggest locations and we can merge this.