search

FluxML / DataAugmentation.jl

Flexible data augmentation library for machine and deep learning
https://fluxml.ai/DataAugmentation.jl/dev/
MIT License
41 stars 17 forks source link

Migrate to documenter jl, + doc upgrades #88

Closed isentropic closed 5 months ago

isentropic commented 6 months ago

Moving to documnter jl as per zulip discussion

No deployment has been setup yet.

isentropic commented 6 months ago

@darsnack could you give me some feedback here please? Once we are good with docs I could proceed with functionality

darsnack commented 6 months ago

Sorry for the delay. Will take a look later today.

isentropic commented 6 months ago

I did the changes you requested. I'm not good with yml files and github deployment, so I'm gonna leave up to you. Also currently the landing page link is broken when accessed from other repos. Not sure if it's the fault of other repos or this.

darsnack commented 6 months ago

@isentropic I have added the deployment stuff. The only stuff left in this PR is all related to editing the .md files for the documentation.

I've added flags to the make.jl script that will warn about issues when building the docs. In particular, Pollen would auto-populate an API reference page so that every [`func`](@ref) had an associated docstring. Documenter does not do this, so we need to manually insert the docstrings.

Can you pull the latest and re-run the doc build? You'll see the warnings telling you which functions/types you need to include a docstring for. If a page exists that's an appropriate home for the missing docstring, then add it there. For example, DataAugmentation.ImageToTensor can go on the transformations.md page. If an appropriate page does not exist, then create a new .md file for it. Use your best judgement and try to get to no more warnings. Then we can rearrange together after you push these changes.

isentropic commented 6 months ago

yeah, done

isentropic commented 5 months ago

@darsnack any updates on this?

darsnack commented 5 months ago

I should have posted an update. I was reorganizing things locally for this PR. I will make those changes on a new PR now.

Thanks for doing the lion's share of the work @isentropic!