-
Notifications
You must be signed in to change notification settings - Fork 142
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
Issue 1759 documentation #1760
base: master
Are you sure you want to change the base?
Issue 1759 documentation #1760
Conversation
- removed DOC_DEPS from all_deps
I think the instructions on how to build the docs should be added to DEVELOPMENT.md since DOCUMENTATION.md dstack/.github/workflows/docs.yaml Lines 26 to 31 in 55d09a7
|
Thank you @r4victor for reviewing the work. Will incorporate the feedback. |
@r4victor : I have incorporated the feedback suggested. |
The deps list is missing pillow and cairosvg. Also, there should be an instruction for installing system deps on Linux/macOS. I think It's more flexible to put docs deps in requirements_docs.txt so that the contributors don't need to install them if they are not working on docs. |
Why not using poetry instead of requirement.txt? |
@bikash119 I'm sorry but I don't see much value in this PR. The issue is important. Indeed it's unclear how to contribute to the docs and test the results. However, this PR doesn't help much. |
Thank you for your comments @peterschmidt85 . Based on comments from @r4victor , I think a external contributor can comment out the |
@bikash119 Basically we could add |
@peterschmidt85 : In my first PR I had the exact same approach of adding |
@bikash119 We've just discussed it with @r4victor and agreed on the following:
|
Thank you @peterschmidt85 for detailed notes. Will work on it right now. |
Here are my changes:
|
@bikash119 You changed |
My bad @peterschmidt85 . Let me rework on it. |
- added the documentation dependencies to requirements_doc.txt
@peterschmidt85 , since this branch was messed up because of deletions and additions of new files. I have created a new PR : #1848. |
This PR closes #1759