ROCM-DOCS-BUILD(1)
π ROCM-DOCS-BUILD π
okay bestie, this is a User Command, it's called rocm-docs-build, and it's here to build docs. that's the whole gig. let's go π«Ά
β¨ NAME β¨
rocm-docs-build β Build documentation for ROCm π
πΈ SYNOPSIS πΈ
rocm-docs-build [OPTION]
π¦ DESCRIPTION π¦
so rocm-docs-build builds the rocm documentation using the ROCm sphinx plugin and theme. it's dedicated to the debian ROCm maintainer, and also to any user out there who wants to rebuild the doc online. iconic behavior honestly π
a couple things you need to know before you run this, no cap:
- a ROCm
./docsdirectory must be in the current directory. like, that's non-negotiable bestie π¨ - the doc gets generated in the
./build/htmldirectory by default π - you can use the
urlandbranchenv var if you need to π§
and now the options, one at a time, because we don't skip π :
-h,--helpβ shows this help. the classic. the moment.-u,--updatedataβ updatesdebian/rocm_datafor therocm-docs-corepackage. it will only apply ifdebian/rocm_datais found, so if it's not there, nothing happens, periodt.-o,--onlineβ builds the documentation with internet access. the default is no internet access, jsyk π-v,--versionβ displays the rocm version β¨-n,--nopatchβ disables the patch ondocs/conf.py. leavingconf.pyalone, as a treat π-r,--rocmversionβ overrides the rocm version fromdebian/rocm_dataπ₯-t,--targetdirβ overrides the default output location π¦
π AUTHOR π
Written by Christian Bayle π
π COPYRIGHT π
Copyright Β© 2025 Christian Bayle <bayle@debian.org>
ok that's the whole page, you ate it π this was rocm-docs-build 0.0.1 from June 2026, and yeah β same name up top, same name down here, ROCM-DOCS-BUILD(1), we stay consistent in this house πβ¨
π¦ where this page comes from
- ubuntu stonking: python3-rocm-docs 1.35.0-3 Β· MIT
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms