Changelog#

[0.10.22] - 2025-11-19#

  • Fix some functions with decorators are not documented

  • Fix for not documenting classes and functions that are not imported directly

[0.10.21] - 2025-11-15#

  • Fix input context too long when generating docstring for module

  • Fix private classes do not have docstrings generated

  • Fix issue capturing screenshot from invalid window

  • Fix issue when generate stubs

  • Fix overview not added to extension.toml

[0.10.20] - 2025-09-24#

  • Fix Python 3.12 compatibility: use raw strings for regex patterns to avoid SyntaxWarning

[0.10.19] - 2025-08-22#

  • Fix for schema extensions have missing schema docs

[0.10.18] - 2025-08-09#

  • Add documentation for USD schema file

  • Avoid mentioning parameters of schema classes in overview

  • Fix for AI making assumptions in c++ overview

  • Fix for AI being confused by plugin and extension names in c++ overview

[0.10.17] - 2025-08-07#

  • Fix for docstring generation is skipped when there are existing docs

  • Fix for apis being wrapped with `` have broken hyperlinks

[0.10.16] - 2025-08-05#

  • Reduce parallel docstring generation to 2

  • Fix an issue when parsing premake for generating cpp overview

[0.10.15] - 2025-08-01#

  • Fix for loading extensions with version ending with “-coreapi”

  • Fix for error when extracting settings

  • Fix screen capturing a non existent window

[0.10.14] - 2025-07-28#

  • Fix for error when extracting settings code

  • Fix for the overview diff agent mentioning versioning changes

[0.10.13] - 2025-07-23#

  • Add diff prompt to command agent

[0.10.12] - 2025-07-16#

  • Add diff prompt to settings agent

  • Fix for settings that needs construction during runtime are not extracted

[0.10.11] - 2025-07-15#

  • Add generated schema information for schema typed extensions.

  • revert the “Fix urllib3’s redirect handling behavior” which is not working

[0.10.10] - 2025-07-11#

  • Fix urllib3’s redirect handling behavior.

[0.10.9] - 2025-07-11#

  • Added NVIDIA copyright headers to Python files

[0.10.8] - 2025-07-11#

  • Add overview diff agent

  • Add diff prompt to diagram agent

[0.10.7] - 2025-07-10#

  • Avoid load extension which is not compatible with the current platform, e.g. linux load windows only extension.

  • Add that platform specific information to overview agent.

[0.10.6] - 2025-07-09#

  • Overview provides more specific and accurate information related to the extension instead of writing brief statements.

[0.10.5] - 2025-07-09#

  • Fix using UI components headings for non-ui elements.

[0.10.4] - 2025-07-08#

  • Add retry to sonnet models when there are network errors

  • Fix error in during docstring retry

[0.10.3] - 2025-07-08#

  • Add python api diff to usage agent to update existing examples instead of generating from scratch

  • Fix error capturing usage screenshots

  • Fix generated python stubs are not updated when the respective input files are changed

[0.10.2] - 2025-07-04#

  • A few fixes on DiagramAgent: make sure only public APIs are included, only connections > 3 adds a diagram, make sure diagram format is correct.

  • overivew should never hallucinate about relationships between concepts

  • docstring should minimize the duplication between description and Returns

  • use the same terminology across the file

[0.10.1] - 2025-07-03#

  • Add basic omni.ui information for usage agent to write basic code for widgets

[0.10.0] - 2025-07-03#

  • Remove regex check to filter objects not in the git diff

  • Enable docstring generation for private objects

[0.9.98] - 2025-07-01#

  • Add git diff to docstring agent to determine if a docstring needs updating

  • Fix for class docstring is not checked

[0.9.97] - 2025-06-30#

  • avoid deprecated settings in both settings and overview

  • settings should have delimiters in overview

  • settings should be in full path in overview

[0.9.96] - 2025-06-26#

  • remove index.rst it is minimum.

  • usage sample url/path should be simplified.

[0.9.95] - 2025-06-26#

  • Fix settings defined in the extension could be missing from the toml file

  • Fix usage misuse the settings with settings passed in as the input

[0.9.94] - 2025-06-25#

  • Fix settings using variable names instead of the actual path

[0.9.93] - 2025-06-25#

  • Avoid writing about APIs at all when generating C++ overview

[0.9.92] - 2025-06-24#

  • Fix for usage agent not using global instances when there is already one

  • Merge examples demonstrating similar small features of the same API class

  • Fix for usage agent writing useless code

  • Fix for making examples async for no obvious reasons

  • Avoid enabling the extension that we are generating usage for

[0.9.91] - 2025-06-19#

  • Fix for settings are listed in the wrong section

[0.9.90] - 2025-06-19#

  • Fix for usage screenshots could get enormously large

[0.9.89] - 2025-06-13#

  • Fix wrong quotes being used

  • Fix for referencing extensions is not done correctly when it followed by a period.

[0.9.88] - 2025-06-13#

  • Avoid creating references for variables in overview

[0.9.87] - 2025-06-12#

  • Improve docstrings to make it more concise and easier to understand from user’s perspective

[0.9.86] - 2025-06-09#

  • Add support for generating overview for C++ extensions

[0.9.85] - 2025-06-04#

  • Fix for not documenting kwonlyargs in docstrings

[0.9.84] - 2025-06-02#

  • Add sonnet-4 and opus-4 into the perflab model

  • Add log_path settings to enable the usage and overview log

  • Fix docs_images folder are not cleared properly

[0.9.83] - 2025-05-30#

  • Remove the only extension class if it’s the only one in all

[0.9.82] - 2025-05-29#

  • OMPE-47377: solve the wrong mention of omni UI in both docstring and overview

  • teach overview agent to understand how extensions are linked through naming convensions

  • add extension name to the docstring agent

  • better docstring agent prompt

  • OMPE-47224: no mention settings when not important.

[0.9.81] - 2025-05-28#

  • OMPE-47459: avoid too marketing kind of sentence

  • OMPE-46990: use technical terminology rathan than generic terms.

[0.9.80] - 2025-05-28#

  • skip documentation generation when there is enough existing documentation

[0.9.79] - 2025-05-28#

  • avoid writing about startup and shutdown in extension class docstrings

[0.9.78] - 2025-05-28#

  • OMPE-47002: fix code duplication from code validation.

[0.9.77] - 2025-05-28#

  • OMPE-47453: fix public APIs are not extracted correctly

  • OMPE-46977: not mention actual order from extension.toml

  • OMPE-46989: avoid special character in Overview

[0.9.76] - 2025-05-28#

  • Fix for the code reviewer agent being too strict on detecting overlapping code

  • Bring back monkey patch of ui.Workspace.get_show_window_titles as it is not available in Kit 107.0

[0.9.75] - 2025-05-27#

  • avoid generic information around configuration and extension itself

[0.9.74] - 2025-05-26#

  • Remove empty sections in settings.md

[0.9.73] - 2025-05-21#

  • Avoid capturing usage example screenshots if the window is not created within the extension

[0.9.72] - 2025-05-20#

  • Avoid documenting deprecated APIs in overview and usage

  • Fix for mentioning too generic info in overview

  • Remove duplicate attributes in all.

[0.9.71] - 2025-05-20#

  • Ensure overview is always the first page

[0.9.70] - 2025-05-16#

  • OMPE-47475: Fix settings generation which could have settings from other exts in the extension.toml file

  • OMPE-47467: avoid using main guard for usage code generation

[0.9.69] - 2025-05-16#

  • Ensure overview and settings ends with new line

[0.9.68] - 2025-05-13#

  • Also capture windows from the extensions which are currently shown

  • Fix for screen captures being cropped incorrectly

[0.9.67] - 2025-05-08#

Fixed#

  • Avoid updating docstrings when the format is correct.

  • Fix for keyword arguments listed incorrectly.

  • Make sure to explain method names with acronyms in its full form in docstrings.

  • Fix for attribute docstrings not being added when class docstring doesn’t exist.

  • Fix for trying to document “cls” argument in class methods.

[0.9.66] - 2025-04-30#

  • Fix path error when picking preview image

  • Avoid removing variables from python_api.md

  • Improve overview for technical accuracy

[0.9.65] - 2025-04-25#

  • Fix for loading non reloadable extensions

  • Fix for app ready event not received

[0.9.64] - 2025-04-25#

  • fix docs generation always return 1 as error

  • fix ai_docs_gen script when repo_docs doesnt have kit

[0.9.63] - 2025-04-24#

  • Fix for error when loading schema extensions

  • Fix removing usage images from the wrong directory

[0.9.62] - 2025-04-17#

  • Input python bindings stub to overview and usage agent

  • Exit with error when extension failed to load

  • Only load python modules within in the specified extension path

  • Fix add_all_attr not adding functions or classes from python bindings

[0.9.61] - 2025-04-14#

  • Fix empty overview should not have key components

[0.9.60] - 2025-04-16#

  • Add preview agent to make sure overview preview is a valid screenshot of a widget or window

  • Fix error with invalid all attributes

  • Fix deprecation error of using legacy carb event streams

[0.9.60] - 2025-04-16#

  • Add preview agent to make sure overview preview is a valid screenshot of a widget or window

  • Fix error with invalid all attributes

  • Fix deprecation error of using legacy carb event streams

[0.9.59] - 2025-04-15#

  • Fix USAGE_PYTHON doc build error when retry time exceeded

[0.9.58] - 2025-04-11#

  • add preview of windows from ui.Workspace.set_show_window_fn

  • clean images in doc_images after a new run

  • fix loading extension from the wrong path

[0.9.57] - 2025-04-10#

  • Fix usage code has the same titles

  • Fix usage code generation for multi-module extensions

  • Move the usage code save with images into CodeReviewerModifier

  • Increase usage_code_timeout

[0.9.57] - 2025-04-11#

  • Add check to ensure preview image exists

  • Fix for code example error in docstring

[0.9.56] - 2025-04-09#

  • Fix usage code didn’t clean the valid code before new run

  • Improve the reviewer duplication check condition and solution

  • Fix usage code stuck at _retry_on_generation

  • Fix docstring still contains \n and special space

[0.9.55] - 2025-04-09#

  • Fix all attributes order is not same as import order

  • Fix trying to add preview to overview when it doesn’t exist

[0.9.54] - 2025-04-08#

  • Fix hang when modifying all attribute

  • Fix for stating “no arguments” in docstrings

  • Fix for making overview links bold

[0.9.53] - 2025-04-07#

  • Prioritize adding preview image to overview if it exists

[0.9.52] - 2025-04-04#

  • Better overview prompt for empty public APIs.

  • Fix docstring is added for non public APIs.

  • Fix function variables not defined.

  • Fix edge case for get_instance and extension class for overview and usage.

  • Fix files for stub generation when public APIs are empty

[0.9.51] - 2025-04-03#

  • Avoid use word of “streamlined UI” or “media” kind of word in docstring or overview

  • For exts which have SETTINGS.md exist, no updates on the content of the items already exist. Allow add or remove items

  • Remove get_instance for overview and usage generation if it is the only public API

  • make Exts ID bold in Overview

  • remove internal used info from toml file for overview generation, e.g. category, support_level

  • add serialization consideration for overview

  • add example of avoid removing important docstring info from existing ones.

  • small examples of making overview more consise, and use more relevant sections where needed.

[0.9.50] - 2025-04-02#

  • add CodeReviewerModifier to review the usage code generation and rerun if review failed

  • fix usage code contains private or protected APIs

[0.9.49] - 2025-03-21#

  • Avoid removing extension class from all as it may error out repo checkapi

  • Fix kit version

[0.9.48] - 2025-03-21#

  • Fix for doc build issues for extensions with ogn nodes.

[0.9.47] - 2025-03-19#

  • images are generated into data/docs_images instead of docs directly since images are ignored under docs folder

  • center the images in the docs pages

  • avoid commit .kit file in ai_docs_gen.py since it will have generated part info

  • fix docstring agent

  • bring back omni.ai.langchain.agent.omni_ui test

  • center mermaid diagram

[0.9.46] - 2025-03-20#

  • fix failed test

[0.9.45] - 2025-03-19#

  • add usage preview to overview

  • avoid capturing black screenshots

[0.9.44] - 2025-03-17#

  • change usage model to use P-Sonnet-3.7-Thinking

  • fix a bug for usage that the extension should be enabled

[0.9.43] - 2025-03-15#

  • Restore usage screenshots

[0.9.42] - 2025-03-13#

  • use relevant usage code for APIs as refernce code instead of test code to include more implementation details

  • create window for widget typed API

[0.9.41] - 2025-03-11#

  • fix stub_content is empty for usage generation

  • fix execute_python_code causing error of “cannot unpack non-iterable NoneType object” for correct code

[0.9.40] - 2025-03-06#

  • add diagram agent

  • fix used defined all has the constants, so we cant add links to overview.

[0.9.39] - 2025-03-06#

  • clean the examples for overview

  • fix issue for extensions without public APIs

  • restruct the overview agent so that we can have consistent H2 headings.

[0.9.38] - 2025-03-05#

  • add extension.toml for overview generation

  • improve a bit on overview prompt

[0.9.37] - 2025-03-05#

  • ensure overview sections have more consistent titles

  • add sonnet 3.7 model

[0.9.36] - 2025-03-04#

  • remove ReviewAllAgent, use code instead

  • add support for multiple-module extensions

[0.9.35] - 2025-02-27#

  • update overview agent

  • add links to the overview

[0.9.34] - 2025-02-24#

  • fix stuck at inspecting modules

  • make sure to remove all the overview links

[0.9.33] - 2025-02-21#

  • fix a few docstring issues

[0.9.32] - 2025-02-19#

  • fix review all agent stuck due to write issue.

  • add remove constant rule to review all agent.

  • make sure docstring has two newlines between each section to have correct format.

[0.9.31] - 2025-02-19#

  • fix review all agent output is not converted into a list of strings

  • remove General Use Case when there is no usage

[0.9.30] - 2025-02-18#

  • fix module docstring include invalid characters in base class

  • fix inspect_module stuck due to the check if a Singleton class is a command class

[0.9.29] - 2025-02-18#

  • fix overview not generated when all is empty.

  • avoid generating usage when all is empty.

[0.9.28] - 2025-02-18#

  • fix module docstring include special characters

  • remove project name in repod_docs config from repo.toml. Otherwise got ci error when build docs.

[0.9.27] - 2025-02-17#

  • fix overview link issue

[0.9.26] - 2025-02-14#

  • avoid waiting for async functions outside generated code snippets while doing usage generation

[0.9.25] - 2025-02-14#

  • review the all attribute generated through imports and update it if it is not correct

[0.9.24] - 2025-02-13#

  • fix that overview heading is not correct and add settings and commands to the overview links if exist

[0.9.23] - 2025-02-12#

  • fix that usage can stuck due to AI generating bad async code

[0.9.22] - 2025-02-12#

  • add GPT o3-mini model

[0.9.21] - 2025-02-03#

  • add CommandDocAgent to generate commands_api.md page

[0.9.20] - 2025-02-10#

  • fix version bump issue

[0.9.19] - 2025-01-30#

  • add deepseek model

[0.9.18] - 2025-01-24#

  • OMPE-36099: Fix usage code generation getting stuck

  • Add GPTo1 model

[0.9.17] - 2025-01-24#

  • fix unregister issue

[0.9.16] - 2024-10-25#

  • includes black==24.10.0

[0.9.15] - 2024-08-09#

Fixed#

  • use register_perflab_gpt4 locally

  • fix the version not updated correctly when the extension is not in the extension info

  • fix the issue when extension is loaded before the version bump

[0.9.14] - 2024-08-07#

Fixed#

  • Only re-generate the stub file if it doesn’t exist or is empty.

  • Fixed indent in prompts.

  • Fixed extension not being loaded from extension path setting.

[0.9.13] - 2024-08-05#

Fixed#

  • Ensure stub file is generated every time when running the tool

  • Added error messages when overview and usage failed to generate due to invalid stub file

[0.9.12] - 2024-08-05#

Fixed#

  • Fix error message “No module named black” in Windows

[0.9.11] - 2024-07-31#

Fixed#

  • Ai agent hallucinates settings used by the extension and provided from another

  • Docstring should have the tripple quotes end in a new line if the docstring are multiple lines.

  • Returns None shouldn’t be in the docstring

  • Change the docstring log info to print so users can get better idea of the progress and what went wrong.

[0.9.10] - 2024-07-31#

Changed#

  • Improved test coverage to 87%.

Fixed#

  • Fixed screenshot generation could crash sometimes.

  • Fixed screenshot generation could capture the wrong part when new windows are created.

[0.9.9] - 2024-07-30#

Fixed#

  • AI turns to stuck at the existing docstring for class. Better prompt to fix that.

  • Fix when only generating docstring, app hangs.

  • Readme has wrong generate key for docstring.

[0.9.8] - 2024-07-27#

Fixed#

  • Fixed screenshot generation could hang on Linux when waiting for screen capture.

[0.9.7] - 2024-07-26#

Fixed#

  • Avoid bumping extension version when generating screenshots for usage code blocks.

[0.9.6] - 2024-07-25#

Changed#

  • Avoid the hot load during the modification on the extension

  • Inject docstrings all together by files instead of one by one which improves the docstring generation performance by roughly 20%

  • Added the customized prompt note in Readme

  • Fix the docstring not running if the root folder is not a module, instead the root folder + file name is the module name

  • Fix the extension name different from module name

[0.9.5] - 2024-07-24#

Changed#

  • No dependency on lc_agent_chat_models

[0.9.4] - 2024-07-23#

Fixed#

  • Fixed tests not being run.

[0.9.3] - 2024-07-19#

Fixed#

  • Fixed the issue that when shutdown the app, the extension no longer exists

  • Exit the app when load is not succeeded

  • Correct the next patch version for version bump

  • Clean up the load_extension

[0.9.2] - 2024-07-17#

Added#

  • Add a setting as separate tool to generate screenshots for usage code examples.

[0.9.1] - 2024-07-17#

Fixed#

  • remove unnecessary space before Args and Returns in docstrings

  • add new line for settings entry in Overview.md

[0.9.0] - 2024-07-16#

  • omni.ai.langchain.agent.documentation

[0.1.30] - 2024-07-15#

Fixed#

  • Remove SETTINGS.md in config/extension.toml and Overview.md if not generated.

  • Don’t bump the version when using add_all_attribute flag.

  • Remove duplicated code due to merge.

  • Fixed the docstrings for subclasses’ methods are not generated.

[0.1.29] - 2024-07-11#

Fixed#

  • Use async task to improve the async functions performance.

[0.1.28] - 2024-07-10#

Fixed#

  • Avoid showing the code snippet twice in usage retry prompt.

[0.1.27] - 2024-07-10#

Fixed#

  • Fix for the agent not wrapping the json payload correctly.

  • Fix for incorrect class docstring format.

Changed#

  • During retry, only generate docstrings which are missing.

  • Changed ‘make sure’ to ‘ensure’ in prompts to save tokens.

[0.1.26] - 2024-07-09#

Changed#

  • Keep the logging level in the subprocess

  • Change retry time for usage from 7 to 3

[0.1.25] - 2024-07-09#

Changed#

  • Clean up the code

  • Added time profiling for performance

[0.1.24] - 2024-07-09#

Fixed#

  • Fixed missing empty lines between usage examples.

[0.1.23] - 2024-07-05#

Added#

  • Increase test coverage of usage code execution.

  • Generate stub code in _genoutput.

Fixed#

  • Fix for hang when executing usage code.

Changed#

  • Improve performance of usage code execution by executing multiple snippets at once and only retry snippets with errors.

  • Moved the whole usage generation to subprocess.

[0.1.22] - 2024-07-05#

Fixed#

  • Fix the missing version error and the common path error.

[0.1.21] - 2024-07-04#

Added#

  • Added test coverage of OverviewUpdaterModifier.

Fixed#

  • Fix for load extension failed due to mixing absolute and relative pathing.

[0.1.20] - 2024-07-04#

Fixed#

  • Fix the public_api_list passed to OverviewUpdaterModifier is a list instead of dict

[0.1.19] - 2024-07-04#

Fixed#

  • Fix stub generation error due to the issue that module and class/func object file path styles are not same

[0.1.18] - 2024-07-02#

Changed#

  • Add example to show UsageDocAgent how to derive code snippet from test

  • fix important API list and add it to both Overview and Usage.

  • Change a usage example to omni.ui example to avoid generating widget directly on ui.Window instead of ui.Frame.

[0.1.17] - 2024-07-02#

Changed#

  • Switched to using mypy for generating stub files.

[0.1.16] - 2024-06-27#

Fixed#

  • Fix for traceback info not shown during usage code retry because it could not be pickle.dumped.

  • Fix for private methods being generated in stub files.

  • Fix for some files could be missed out when generating stub files.

Changed#

  • Generate functions in the same file in one go.

  • Add references for important API list in overview.

[0.1.15] - 2024-06-27#

Changed#

  • Pass settings list from toml file as the input of the SettingDocAgent

  • Only code contains settings related are concatenated as input code

  • If neither settings list nor settings code exists, don’t run SettingDocAgent

  • Better settings description example, remove the action words in the description

  • Avoid OmniKit in module docstring

  • Remove all the concatenation file path and clean up the concatenation

  • Fix the __all__ generation for the extension instead of submodules and make sure generated list also include attributes and not just class/function

  • Move generate __all__ as a pre-process so that user and interfere before running ai agents.

[0.1.14] - 2024-06-26#

Fixed#

  • Fix for reference to USAGE_PYTHON is missing in overview page.

  • Fix for test code being ignored on Windows.

  • Fix for usage code generation could not be keyboard interrupted.

Changed#

  • Use stub code for generating overview and usage to avoid running into token limit error.

[0.1.13] - 2024-06-26#

Fixed#

  • Fix relpath error occurring when file in different driver.

[0.1.12] - 2024-06-19#

Changed#

  • Terminated the docs generation if the extension doesn’t import, and provide better error message for that.

  • Sliced large number of class methods into smaller ones to avoid context_length_exceeded errors.

  • Add retry on missed docstring so to make sure we don’t have missed ones.

  • Enhance methods docstring generation only on public methods.

  • Enhance class methods docstring is a single string (avoid generating Dict in docstring).

  • use __doc__ instead of inspect.getdoc to avoid getting parent class’ documentation.

[0.1.11] - 2024-06-18#

Fixed#

  • Fix for generation could not be keyboard interrupted.

  • Fix for documentation being created in the build directory.

Changed#

  • Moved usage code execution to subprocess.

[0.1.10] - 2024-06-18#

Fixed#

  • Fix for the agent could sometimes hallucinate on important API list.

[0.1.9] - 2024-06-14#

Fixed#

  • error when querying the arguments of class methods which have decorators

  • issue with attributes docstring generation

[0.1.8] - 2024-06-14#

Added#

  • Added setting to create __all__ attribute if it does not exist.

Fixed#

  • Fixed crash when generating usage code with omni.ui.

  • Docstring argument types do not use sphinx references.

  • Automatically update config file for generated documentation files.

  • Avoid listing documentation files which do not exist.

[0.1.7] - 2024-06-13#

Changed#

  • Improved the logging system for the extension, for better post inspections on the ai generated docs.

  • Better retry logic on DocstringInjectorModifier.

  • Fixed docstring new line issue.

  • Fixed docstring json payload has invalid key, which is not a class/method name, e.g. the key is “ClassName”.

  • Fixed docstring json payload has incomplete key for property method, e.g. ClassName.MethodName.getter.

  • Removed argument mismatch retry.

  • The file location is removed from prompts, instead it is directly passed through modifier.

  • Make sure class’ docs don’t get parent’s class’s docs which cause generation miss.

  • Remove extension precacher.

[0.1.6] - 2024-06-05#

Added#

  • OMPE-8327: Added tests

Fixed#

  • Fix for docstring not being generated for all classes and functions, and arguments could be missing

  • Ensure each setting name format is correct, and avoid creating the markdown file when there are no settings

  • Fix for usage examples with asyncio tasks could crash when there are errors

Changed#

  • Updated documentation with AI agent.

[0.1.5] - 2024-06-10#

Fixed#

  • workaround the No module named regex._regex issue

[0.1.4] - 2024-06-10#

Changed#

  • use register_perflab_gpt4 from lc_agent_chat_models instead from langchain_openai

[0.1.3] - 2024-06-06#

Fixed#

  • Docstring generation doesn’t follow the correct output format.

[0.1.2] - 2024-06-05#

Changed#

  • Fix error message “No module named black”

  • Remove the extension itself from the Important API list in the overview.

  • Avoid the use of Omni Kit in overview

  • Update readme about important API list could be retrieved from __all__

[0.1.1] - 2024-06-03#

Fixed#

  • Move the file_path from ai generated to ai input

  • Fix when using _build folder the python files is not corrected built for input

  • Fix subprocess env issue for Windows

[0.1.0] - 2024-04-10#

  • Initial version of extension ai docs generator

On this page