documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Auto generate `occ` namespace overviews

Open joshtrichards opened this issue 1 year ago • 3 comments

We should auto-generate the occ the command overview sections. We can use GitHub workflows to run occ periodically against new Nc releases.

This should greatly improve the accuracy of the Admin Manual occ chapter and streamline the labor intensity of keeping it up-to-date.

https://github.com/nextcloud/documentation/labels/feature%3A%20occ

joshtrichards avatar Nov 20 '24 16:11 joshtrichards

This Sphinx extension could facilitate this:

https://github.com/OpenNTI/sphinxcontrib-programoutput

joshtrichards avatar Feb 02 '25 16:02 joshtrichards

Looks like when we bump to symfony/console >= 6.3 there is native RST output support for help command output (!):

https://github.com/symfony/symfony/commit/f3ab66e0b3e83da459003fe081ab3aca8c0a023c

joshtrichards avatar Jul 31 '25 13:07 joshtrichards

Talk app has an in-repo implementation used to generate it's occ docs which might be reusable: https://github.com/nextcloud/spreed/blob/dd0a6c454f4f1ec574f81457cdaef70609f2bdc2/lib/Command/Developer/UpdateDocs.php

joshtrichards avatar Nov 29 '25 14:11 joshtrichards