New documentation with Jupyter book

[miguelgfierro]

Description

Documentation with Jupyter Book. It can be found here: https://recommenders-team.github.io/recommenders

Related Issues

#2016

References

Checklist:

• I have followed the contribution guidelines and code style for this project.
• I have added tests covering my contributions.
• I have updated the documentation accordingly.
• This PR is being made to staging branch and not to main branch.

[miguelgfierro]

If I add a relative path, it doesn't show in the table of contents

parts:
  - caption: Getting Started
    chapters:
      - file: ../SETUP.md

[miguelgfierro]

The error: ERROR: Unexpected indentation. means that there is no docstring o_o

Very descriptive. Congrats!!

[miguelgfierro]

Error. The documentation is not rendered correctly, there are extra :

Instead of the latest jupyter-book version, 0.15.1, I tried with 0.13.2, and sphinx-4.5.0-> that fixes the issue.

Trying with 0.15.0 and sphinx-v5.0.2 -> it doesn't fix the double : error
Trying 0.14.0 and sphinx 5.0.2 -> it doesn't fix the double : error
Trying 0.14.0 and sphinx 4.5.-> it doesn't build The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.
Trying with 0.15.0 and sphinx-4.5.0 -> it doesn't build The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.
Trying with 0.15.0 and sphinx-5.1.0 (this combination has internal conflicts)-> it fixes the issue https://github.com/recommenders-team/recommenders/commits/f892bf018bbc3f47bff738acaefa094ecdcbdf90

Trying to compile the docs with jupyter-book config sphinx docs/ and sphinx-build docs docs/_build/html -b html. The build passes: https://github.com/recommenders-team/recommenders/actions/runs/7532474883/job/20503161028?pr=2051 -> I still get the double ::

[miguelgfierro]

In PyTorch, they are using sphinx directly:

• conf.py
• make

[agoose77]

@miguelgfierro could you try with the newest version of JB?

[miguelgfierro]

@agoose77 it works now https://recommenders-team.github.io/recommenders/

Thanks man!

[SimonYansenZhao]

.readthedocs.yaml is not used any more if we use Jupyter Book. @miguelgfierro