Sphinx actions

[turian]

This adds github actions for sphinx build and sphinx link check. I also found one broken link.

This isn't perfect because it gets warnings like this:

WARNING: autodoc: failed to import class 'pretrain_dataloader.NCropAugmentation' from module 'solo.utils'; the following exception was raised:
No module named 'solo.utils.pretrain_dataloader'

I think this is because of whether the pip install actually creates the right module names.

[vturrisi]

Hi @turian thanks for contributing. Just so I get it, this will simply check if sphinx is building correctly?

[vturrisi]

I've also just checked and this error is because we changed the structure of the library but did not update the docs. I'll try to address this next week.

[turian]

Hi @turian thanks for contributing. Just so I get it, this will simply check if sphinx is building correctly?

Correct, and also that no links are broken. This is useful for when you start publishing docs on rtfd

[vturrisi]

I see @turian. Gonna check the commit later today/tomorrow and also use your PR to fix the issues that we have with the current documentation.

[codecov[bot]]

Codecov Report

Merging #299 (11ae827) into main (d830ce1) will not change coverage. The diff coverage is n/a.

Flag	Coverage Δ		*Carryforward flag
cpu	81.68% <ø> (ø)
dali	40.06% <ø> (ø)		Carriedforward from 41aa1b4

*This pull request uses carry forward flags. Click here to find out more.

[turian]

@vturrisi Great. I'm excited to work with sololearn but without built docs its hard to know where to start.

In particular, I want to start using solo-learn for non-vision data, using different backbones, and port from my existing vicreg implementation.

[vturrisi]

@turian yes, indeed one thing that's not solidified is our documentation. Hopefully we will get around it in the next months.