ckan icon indicating copy to clipboard operation
ckan copied to clipboard

`ckan shell` command is not documented

Open amercader opened this issue 3 years ago • 3 comments

The very useful ckan shell command introduced in 2.10 (https://github.com/ckan/ckan/pull/6919) is not mentioned anywhere in the docs.

It should be at least mentioned in https://docs.ckan.org/en/2.10/maintaining/cli.html

amercader avatar Feb 20 '23 15:02 amercader

Even better would be to autogenerate our CLI docs using the actual docsttrings of the ckan commands

amercader avatar Feb 21 '23 13:02 amercader

Hi @amercader, I was looking into using sphinx-click to do this. There is a long-standing issue in sphinx-click/sphinx around referencing a program. The examples in sphinx-click use a URL and path, like

.. |Command| replace:: ``Command``
.. _Command: https://click.palletsprojects.com/en/7.x/api/#click.Command

Are the ckan docs hosted only at one URL?

boydjohnson avatar Mar 10 '23 15:03 boydjohnson

Hi @amercader I want to work on this issue. I will submit a PR for this.

vishal-agr99 avatar Nov 29 '23 05:11 vishal-agr99