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.

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

fix: Readthedocs cannot parse comments, resulting in docs bugs #1033

Merged
merged 1 commit into from
Feb 10, 2025

Conversation

ellistarn
Copy link
Contributor

@ellistarn ellistarn commented Feb 10, 2025

What does this PR do?

Note: Many of these changes are presubmit codegens and not related to my change. Happy to revert if we want to isolate this change.

A recent change to the docs added a comment to the code-genned distribution docs. Readthedocs is unable to parse this, resulting in weird nav and page rendering.

Before
image

Test Plan

[Describe the tests you ran to verify your changes with result summaries. Provide clear instructions so the plan can be easily re-executed.]

python llama_stack/scripts/distro_codegen.py
sphinx-autobuild docs/source build/html
image

@facebook-github-bot
Copy link

Hi @ellistarn!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@facebook-github-bot
Copy link

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Feb 10, 2025
Copy link
Contributor

@hardikjshah hardikjshah left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for the fix

Copy link
Collaborator

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

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

Thanks! Yeah let’s only include relevant changes in this PR

@ellistarn
Copy link
Contributor Author

Will merge #1035 first, and then rebase this.

@ellistarn
Copy link
Contributor Author

Ok -- should be good to go.

@terrytangyuan terrytangyuan merged commit afca9d9 into meta-llama:main Feb 10, 2025
3 checks passed
kaushik-himself pushed a commit to fiddlecube/llama-stack that referenced this pull request Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Meta Open Source bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants