-
Notifications
You must be signed in to change notification settings - Fork 639
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.
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
documentation release v1 #1012
documentation release v1 #1012
Conversation
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
b6c2712
to
fbc0385
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the huge work @Titus-von-Koeller !
I left few comments, we should be almost there to merge this !
Please also see the tips regarding uploading images, writing proper docstring so that things will be compatible with HF-doc builder's auto-doc. Let's also not blow up the documentation with the introduction, a simple index page that redirects users to the correct page should be sufficient. See for example: https://github.com/huggingface/trl/blob/main/docs/source/index.mdx on how to use relative links between different doc pages.
@@ -27,6 +27,7 @@ dependencies: | |||
- conda-forge::monkeytype # infer type annotations | |||
- conda-forge::rich # better, colored tracebacks, etc | |||
- conda-forge::pytest-sugar # better pytest output | |||
# - conda-forge::nodejs # for `doc-builder preview` (optional) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this intended?
docs/source/_toctree.yml
Outdated
# - local: code_of_conduct | ||
# title: Code of Conduct |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# - local: code_of_conduct | |
# title: Code of Conduct |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fantastic work @Titus-von-Koeller ! 🚀 I left few final comments that you can directly apply through GH suggestions ! Let's 🚢 it once we confirm the Doc build is green after applying the suggestions !
Thanks again for putting all your hardwork on this !
Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
Co-authored-by: Younes Belkada <49240599+younesbelkada@users.noreply.github.com>
acc7fb3
into
bitsandbytes-foundation:main
No description provided.