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

Generate list of supported YANG models for documentation #432

Closed
troglobit opened this issue May 13, 2024 · 2 comments · Fixed by #491
Closed

Generate list of supported YANG models for documentation #432

troglobit opened this issue May 13, 2024 · 2 comments · Fixed by #491
Assignees
@troglobit
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
Infix v24.06

Comments

@troglobit
Copy link
Contributor

As discussed in #326, after the big refactor to offline, we could generate a list of supported YANG models, their features, as well as augments/deviations.

As an example, with only a few models, here's how to create a HTML/JavaScript page of IETF System:

pyang -f jstree ietf-system@2014-08-06.yang infix-shell-type@2023-08-21.yang \
                infix-system@2024-04-12.yang > infix-ietf-system.html
@troglobit troglobit added documentation Improvements or additions to documentation enhancement New feature or request labels May 13, 2024
@troglobit troglobit mentioned this issue May 13, 2024
Closed
@troglobit troglobit added this to the Infix v24.05 milestone May 16, 2024
@troglobit troglobit self-assigned this May 24, 2024
@troglobit
Copy link
Contributor Author

troglobit commented Jun 23, 2024 •
edited
Loading

Two alternatives:

@jovatn
Copy link
Contributor

jovatn commented Jun 24, 2024

Wow!

troglobit added a commit that referenced this issue Jun 28, 2024
@troglobit
board/common: extract YANG documentation for all builds
756639a 
This change builds on top of the earlier work to bootstrap Infix YANG
modules at build time.  Adding a step at the end of post-build.sh to
call the yangdoc tool.  The resulting yangdoc.html is a stand-alone HTML
file of (almost) all YANG nodes.  Almost because some top-level nodes
are unused by Infix atm. and have been filtered out for readability.

Fixes #432

Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
@troglobit troglobit linked a pull request Jun 28, 2024 that will close this issue
Documentation updates #491
Merged
13 tasks
troglobit added a commit that referenced this issue Jun 28, 2024
@troglobit
board/common: extract YANG documentation for all builds
b4b9658 
This change builds on top of the earlier work to bootstrap Infix YANG
modules at build time.  Adding a step at the end of post-build.sh to
call the yangdoc tool.  The resulting yangdoc.html is a stand-alone HTML
file of (almost) all YANG nodes.  Almost because some top-level nodes
are unused by Infix atm. and have been filtered out for readability.

Fixes #432

Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
troglobit added a commit that referenced this issue Jun 28, 2024
@troglobit
board/common: extract YANG documentation for all builds
10744c5 
This change builds on top of the earlier work to bootstrap Infix YANG
modules at build time.  Adding a step at the end of post-build.sh to
call the yangdoc tool.  The resulting yangdoc.html is a stand-alone HTML
file of (almost) all YANG nodes.  Almost because some top-level nodes
are unused by Infix atm. and have been filtered out for readability.

Fixes #432

Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@troglobit troglobit

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Infix & C:o
Status: Done
Milestone
Infix v24.06
Development

Successfully merging a pull request may close this issue.

Documentation updates kernelkit/infix
2 participants
@troglobit @jovatn