Add Long-form API documentation

[jatkinson1000]

Add long form API documentation using FORD: https://cambridge-iccs.github.io/FTorch/

• Create GH action
• Create GH page under ICCS
• Add URL to repo
• Run FORD on code
• Add additional md pages
• Update source with comments for FORD where missing
• Move action to rebuild docs for main, not branch

Will close #20

[jatkinson1000]

Currently building at https://cambridge-iccs.github.io/FTorch/
Deployment seems to be working so now need to work on docs.

[jatkinson1000]

Suggestions for additional pages:

• Dome pleasant documentation for the examples
• Methods of installing libtorch/pytorch and where to find it onn the system etc - can be more verbose than README

It was also suggested that we reduce the README to make it more manageable whilst maintaining the key content there.

[ElliottKasoar]

Can this close #5?

[TomMelt]

According to https://forddocs.readthedocs.io/en/latest/user_guide/writing_documentation.html#non-fortran-source-files we should be able to use FORD for the C code. Not sure how well it works though

[jatkinson1000]

Indeed, I am looking at this locally and will push once I have something.

It could close #5 and we should certainly document the C, but we have discussed since that was opened that we are 'branding' as a Fortran API rather than a 'Fortran and C' API since C users will likely know what they are doing with binding to C++.

[ElliottKasoar]

(Mostly a note for myself)

In the GPU section, it might be worth adding something about moving non- parameters/buffers to GPU, as I intend to do in Cambridge-ICCS/FTorch-benchmarks#27.

[jatkinson1000]

(Mostly a note for myself)

In the GPU section, it might be worth adding something about moving non- parameters/buffers to GPU, as I intend to do in Cambridge-ICCS/FTorch-benchmarks#27.

I have added a GPU page - feel free to add to it - maybe on a branch if we want to be safe and then merge back into here.

[jwallwork23]

As discussed offline, perhaps we could work towards getting this PR merged and open new issues for the remaining checklist items? The content here is already a really good starting point. I'd be happy to review this PR if that'd be helpful?

[jatkinson1000]

As discussed offline, perhaps we could work towards getting this PR merged and open new issues for the remaining checklist items? The content here is already a really good starting point. I'd be happy to review this PR if that'd be helpful?

Yes, please do!

[jwallwork23]

This is a really great start - lots of useful content, the FORD setup seems to work well, and the webpage looks nice. I checked all the links I came across and all worked except one (see comments).

Most of my requests are fairly minor and I'd be happy to help resolving them, if that would be useful?

I wonder if something like 'User guide' might be a better heading than 'Other documentation'? Just because there's lots of useful information in there.

[jatkinson1000]

Thanks @jwallwork23 I think those points are all covered in recent commits, including the moving 'Other docs' to 'User Guide'.

Also updated the landing page with latest resources and modified the workflow for main in anticipation of merging.

After casting an eye over I think this is probably now good to go subject to a re-review.

[jatkinson1000]

This will also now close #98 as I have removed/simplified large chunks of the README to point at the online documentation.

[jwallwork23]

Thanks very much for making these changes @jatkinson1000! The docs are now a great source of info for getting started, as well as covering some more advanced topics.

My only final request is very minor (see the unresolved thread above) so I'm happy to approve.