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

docs: update Llama Deploy documentation build #16403

Merged
merged 32 commits into from
Oct 8, 2024
Merged

docs: update Llama Deploy documentation build #16403

merged 32 commits into from
Oct 8, 2024

Conversation

masci
Copy link
Member

@masci masci commented Oct 7, 2024 •
edited
Loading

Description

  • Remove the yaml machinery in the import script, rely on folder content to build nav instead (relying more on the include_dir_to_nav plugin
  • Make Llama Deploy docs more prominent in their own section directly accessible through nav
  • Remove requirements.txt in favor of pyproject.toml
  • Fixed the README
  • Add poetry scripts serve and merge-llama-deploy-docs to run the builds consistently
  • Add an option --skip-notebooks to serve to iterate faster when working outside the examples folder.

Part of run-llama/llama_deploy#291

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Oct 7, 2024
masci
masci commented Oct 7, 2024
View reviewed changes
docs/merge_llama_deploy_docs.py Outdated Show resolved Hide resolved
masci
masci commented Oct 7, 2024
View reviewed changes
docs/mkdocs.yml Outdated
@@ -945,6 +946,80 @@ nav:
- ./api_reference/instrumentation/index.md
- ./api_reference/instrumentation/span_handlers.md
- ./api_reference/instrumentation/span_types.md
- Llama Datasets:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section was reordered to match alphabetically

@masci masci mentioned this pull request Oct 7, 2024
Merged
logan-markewich
logan-markewich reviewed Oct 7, 2024
View reviewed changes
docs/mkdocs.yml Outdated Show resolved Hide resolved
@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Oct 8, 2024
logan-markewich
logan-markewich approved these changes Oct 8, 2024
View reviewed changes
Copy link
Collaborator

@logan-markewich logan-markewich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me (I'm not sure if there is an order these need to be merged or not)

@dosubot dosubot bot added lgtm This PR has been approved by a maintainer size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Oct 8, 2024
logan-markewich
logan-markewich reviewed Oct 8, 2024
View reviewed changes
docs/scripts/serve.py Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seldo will appreciate this one

@masci masci requested a review from logan-markewich October 8, 2024 17:28
@logan-markewich logan-markewich enabled auto-merge (squash) October 8, 2024 19:22
@logan-markewich logan-markewich merged commit 40d1161 into main Oct 8, 2024
11 checks passed
@logan-markewich logan-markewich deleted the massi/llama-deploy-docs branch October 8, 2024 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nerdai nerdai nerdai left review comments

@logan-markewich logan-markewich logan-markewich approved these changes

Assignees
No one assigned
Labels
lgtm This PR has been approved by a maintainer size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@masci @logan-markewich @nerdai @eltociear @rakeshmehta0308 @shubham0204 @vagenas @g-hano