Hi,

the way to document the option of a unix command is:

.. program:: rm

.. option:: -r

Referencing the option with :option:`rm -r`.

How would you document a command with subcommands?

Eg.

hugo

is the command to start the static site generator hugo.

hugo server

is the command subcommand combination to start a webserver that displays
the generated website.

I could say:

.. program:: hugo

.. option:: server

and reference the subcommand simply as :option:`hugo server`

But this seems to be wrong.

Is there a better way?

juh


-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Reply via email to