[Docs] Generate Documentation from live objects instead of parsing the source code #539
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix broken links
Fix upstream conflicts
Fix upstream conflicts 1
Review fixes
davorrunje
approved these changes
Jan 22, 2025
stellaxiang
pushed a commit
that referenced
this pull request
Jan 23, 2025
…e source code (#539) * WIP * updated mako template * WIP * Update meko template * Update meko template * Use pdoc3 for generating the API docs * Fix the generated docs/reference directory structure * Polishing * polishing * Remove setup.py * Remove docs-requirement file * Polishing * Polishing * Docs test * Docs test * Fix broken links * Remove docs extra from dev * Add missing packages * Remove redundant command * Add returns section to docs * Update docs * Update python version in workflow file * Pass OPENAI_API_KEY in CI * Fix review comments * Remove docs from dev extra * Add quotes around each packahe name * Polishing * WIP * WIP * Fix missed import in file * Fix missed third party imports in arxiv files * Add jinja in docs dependency * Cleanup * Polishing --------- Co-authored-by: Kumaran Rajendhiran <[email protected]>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 30, 2025
* Init gemini realtime blogpost * Update authors * added setup file generation * [Docs] Generate Documentation from live objects instead of parsing the source code (#539) * WIP * updated mako template * WIP * Update meko template * Update meko template * Use pdoc3 for generating the API docs * Fix the generated docs/reference directory structure * Polishing * polishing * Remove setup.py * Remove docs-requirement file * Polishing * Polishing * Docs test * Docs test * Fix broken links * Remove docs extra from dev * Add missing packages * Remove redundant command * Add returns section to docs * Update docs * Update python version in workflow file * Pass OPENAI_API_KEY in CI * Fix review comments * Remove docs from dev extra * Add quotes around each packahe name * Polishing * WIP * WIP * Fix missed import in file * Fix missed third party imports in arxiv files * Add jinja in docs dependency * Cleanup * Polishing --------- Co-authored-by: Kumaran Rajendhiran <[email protected]> * Add blog post for ChatContext dependency injection (#613) * Initial ChatContext DI blog * ChatContext blog post WIP * ChatContext blog post * [Docs] Resolve mypy type-checking issues in docs generation files (#621) * WIP * updated mako template * WIP * Update meko template * Update meko template * Use pdoc3 for generating the API docs * Fix the generated docs/reference directory structure * Polishing * polishing * Remove setup.py * Remove docs-requirement file * Polishing * Polishing * Docs test * Docs test * Fix broken links * Remove docs extra from dev * Add missing packages * Remove redundant command * Add returns section to docs * Update docs * Update python version in workflow file * Pass OPENAI_API_KEY in CI * Fix review comments * Remove docs from dev extra * Add quotes around each packahe name * Polishing * WIP * WIP * Fix missed import in file * Fix missed third party imports in arxiv files * Add jinja in docs dependency * Cleanup * Polishing * wip * WIP * Fix mypy issues * fix typos * pre-commit fixed --------- Co-authored-by: Kumaran Rajendhiran <[email protected]> Co-authored-by: Davor Runje <[email protected]> * Update version to v0.7.2b1 (#623) * Update version to v0.7.2 * Update version.py to b1 * Update year * Update version to 0.7.2 (#625) * add text to realtime gemini blog post * update author url * Cleanup * WIP * Cleanup blogpost * Rewrite intro --------- Co-authored-by: Davor Runje <[email protected]> Co-authored-by: Harish Mohan Raj <[email protected]> Co-authored-by: Kumaran Rajendhiran <[email protected]> Co-authored-by: rjambrecic <[email protected]> Co-authored-by: Mark Sze <[email protected]> Co-authored-by: Stella Xiang <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
The initial implementation of API reference documentation generation relied on source code parsing. This PR introduces the following improvements:
Dynamic Documentation Generation: Python modules are now loaded, and documentation is generated from live objects, ensuring all symbols, including those exported to other modules, are accurately documented.
Enhanced UI Customization: The API documentation UI has been updated to meet industry standards, improving both readability and user experience.
These changes result in more accurate documentation and a professional, polished appearance.
Related issue number
Closes #425
Checks