How to create online documentation with kit-app-template

[ml-thousandlakes]

Hello,

I am using kit-app-template to develop a Kit application with a couple of custom extensions. Everything is going pretty good, I created a couple of app and extensions templates to eliminate initial copy-pasting.

I was wondering if it would be possible to generate HTML (or PDF) documentation using the tools included in the kit-app-template.

Currently, my extensions are in Python, but looks like I’d need to convert some of them to C++. I also would like to add some additional documentation pages (e.g. NetworkX) in addition to the function and class references (e.g. isaac-sim). It would be also great if it would be possible to use custom Sphinx templates as some of them can be installed via pip.

I believe there is a way included in the kit-extension-template, i.e. repo.sh docs. Regarding this method, I’ve found this documentation for repo_docs. On the other hand, my tests for downloading and using repo_docs v1.0.3 have failed with the following error.

PS C:\Users\user\kit-app-template>.\repo.bat build
Package 'repo_docs' at version '1.0.3' is missing from local storage.
Traceback (most recent call last):
  File "C:\Users\user\kit-app-template\tools\repoman\repoman.py", line 28, in <module>
    bootstrap()
  File "C:\Users\user\kit-app-template\tools\repoman\repoman.py", line 21, in bootstrap
    deps = packmanapi.pull(file.as_posix())
  File "C:\packman-repo\packman-common\7.23\packman\utils.py", line 515, in wrapper_message_block
    return func(*args, **kwargs)
  File "C:\packman-repo\packman-common\7.23\packman\main.py", line 1100, in pull
    dep_map = pull_with_variable_file(
  File "C:\packman-repo\packman-common\7.23\packman\main.py", line 1163, in pull_with_variable_file
    pull_map = pull_dependencies(
  File "C:\packman-repo\packman-common\7.23\packman\main.py", line 1364, in pull_dependencies
    raise errors.PackmanErrorFileNotFound(
packman.errors.PackmanErrorFileNotFound: Package not found on specified remote servers! (name: repo_docs, version: 1.0.3)

Do you have any suggestions to achieve building documentation in the way I described above?

Thanks!

[Richard3D]

Thanks for your question about the documentation. At this time we are not ready to release the “Omniverse Documentation System” to the Public. At this time, we advise that the best way is to set up something similar using sphinx, but you would have to configure it yourself.
https://www.sphinx-doc.org/en/master/