Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

creating a doc page with autodocs and everything #3273

Merged
merged 57 commits into from
Sep 18, 2023
Merged

creating a doc page with autodocs and everything #3273

merged 57 commits into from
Sep 18, 2023

Commits on Sep 11, 2023

  1. add basic doc setup

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    66cc15c View commit details
    Browse the repository at this point in the history

  2. document __init__.py

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    50925f2 View commit details
    Browse the repository at this point in the history

  3. make set_proxies follow google docs format

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    f302eff View commit details
    Browse the repository at this point in the history

  4. code formatting

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    ea8fe2a View commit details
    Browse the repository at this point in the history

  5. reconfigure index page

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    431b782 View commit details
    Browse the repository at this point in the history

  6. add grid and getting started section

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    0422c0e View commit details
    Browse the repository at this point in the history

  7. remove doctree

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    d551b1e View commit details
    Browse the repository at this point in the history

  8. add toctree for tutorials api and contributing

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    cbe5322 View commit details
    Browse the repository at this point in the history

  9. add headlines to sections

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    a047fdb View commit details
    Browse the repository at this point in the history

  10. remove redundant titles

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    c67340c View commit details
    Browse the repository at this point in the history

  11. add readme for gh page

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    c08adbe View commit details
    Browse the repository at this point in the history

  12. add contributing docs

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    3a5e55d View commit details
    Browse the repository at this point in the history

  13. fix note parsing

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    ebfc829 View commit details
    Browse the repository at this point in the history

  14. add more autodoc modules

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    1d21ddf View commit details
    Browse the repository at this point in the history

  15. limit depth in toctree

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    5261e07 View commit details
    Browse the repository at this point in the history

  16. fix typo

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    f35439b View commit details
    Browse the repository at this point in the history

  17. improve docstrings of trainer.train_custom

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    5b3fac6 View commit details
    Browse the repository at this point in the history

  18. improve docstrings of trainer.train_custom

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    82a1e0a View commit details
    Browse the repository at this point in the history

  19. improve docstrings of trainer.train_custom

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    2561951 View commit details
    Browse the repository at this point in the history

  20. improve docstrings of trainer.train_custom

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    26f769a View commit details
    Browse the repository at this point in the history

  21. make index more applicable

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    495f4a8 View commit details
    Browse the repository at this point in the history

  22. revert glob change

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    c2044a7 View commit details
    Browse the repository at this point in the history

  23. remove genindex

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    1650c81 View commit details
    Browse the repository at this point in the history

  24. glob without genindex

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    2da5549 View commit details
    Browse the repository at this point in the history

  25. fix getting started link

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    4fdce2c View commit details
    Browse the repository at this point in the history

  26. fix table of content show content for respective sites (api/tutorial/… 

    …contributors)
    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    3a4610f View commit details
    Browse the repository at this point in the history

  27. better structure for embeddings

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    b954939 View commit details
    Browse the repository at this point in the history

  28. use sphinx deprecation

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    ac900c5 View commit details
    Browse the repository at this point in the history

  29. fine grained datasets documentation

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    a0670cd View commit details
    Browse the repository at this point in the history

  30. add tutorials

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    09e7ceb View commit details
    Browse the repository at this point in the history

  31. deploy this branch temporarly

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    c12139e View commit details
    Browse the repository at this point in the history

  32. fix publish docs ci

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    20f2c42 View commit details
    Browse the repository at this point in the history

  33. add edit on github button

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    9266587 View commit details
    Browse the repository at this point in the history

  34. hide ToC on main page

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    451e7b6 View commit details
    Browse the repository at this point in the history

  35. add links to api docs in tutorials

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    61694ef View commit details
    Browse the repository at this point in the history

  36. add favicon

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    85c3de4 View commit details
    Browse the repository at this point in the history

  37. fix sphinx warnings in docstrings

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    8c570ce View commit details
    Browse the repository at this point in the history

  38. fix transformer embeddings tutorial

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    f010c09 View commit details
    Browse the repository at this point in the history

  39. fix :param usage outside of datasets folder

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    67a7b2e View commit details
    Browse the repository at this point in the history

  40. fix updating documentation syntax error

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    0548a96 View commit details
    Browse the repository at this point in the history

  41. remove sidebars from index page

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    d04eba5 View commit details
    Browse the repository at this point in the history

  42. fix wrong link

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    4da11a5 View commit details
    Browse the repository at this point in the history

  43. add custom version-switcher

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    20389cf View commit details
    Browse the repository at this point in the history

  44. add custom pypi icon

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    08396d1 View commit details
    Browse the repository at this point in the history

  45. fix CI-CD name

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    177a138 View commit details
    Browse the repository at this point in the history

  46. add 404 redirect

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    c86215d View commit details
    Browse the repository at this point in the history

  47. global config for autodocs

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    35cf20c View commit details
    Browse the repository at this point in the history

  48. add docs to variables missing

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    c31ab09 View commit details
    Browse the repository at this point in the history

  49. don't use deprecated BPEmbSerializable

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    f1a4d96 View commit details
    Browse the repository at this point in the history

  50. fix rust & mypy errors

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    3ddc564 View commit details
    Browse the repository at this point in the history

  51. fix ruff errors

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    c3ea2b8 View commit details
    Browse the repository at this point in the history

  52. update publish-docs python version

    Benedikt Fuchs committed Sep 11, 2023
    Configuration menu
    Copy the full SHA
    111b0e6 View commit details
    Browse the repository at this point in the history

Commits on Sep 18, 2023

  1. fix dependencies

    Benedikt Fuchs committed Sep 18, 2023
    Configuration menu
    Copy the full SHA
    8d543b3 View commit details
    Browse the repository at this point in the history

  2. fix method references

    Benedikt Fuchs committed Sep 18, 2023
    Configuration menu
    Copy the full SHA
    9d49e9a View commit details
    Browse the repository at this point in the history

  3. fix documented minimal python version

    Benedikt Fuchs committed Sep 18, 2023
    Configuration menu
    Copy the full SHA
    64e4e8c View commit details
    Browse the repository at this point in the history

  4. fix ruff error

    Benedikt Fuchs committed Sep 18, 2023
    Configuration menu
    Copy the full SHA
    ac9220b View commit details
    Browse the repository at this point in the history

  5. remove banch from doc config

    Benedikt Fuchs committed Sep 18, 2023
    Configuration menu
    Copy the full SHA
    a951be1 View commit details
    Browse the repository at this point in the history