Skip to content
This repository has been archived by the owner on Jan 14, 2024. It is now read-only.

Documentation for arguments, options and environment variables of tasks #20

Open
blackandred opened this issue Jun 16, 2020 · 0 comments
Open

Documentation for arguments, options and environment variables of tasks #20

blackandred opened this issue Jun 16, 2020 · 0 comments
Labels
FEATURE New feature or request
Milestone
RKD Next

Comments

@blackandred
Copy link
Contributor

blackandred commented Jun 16, 2020 •
edited
Loading

I think that the Sphinx should be automatically be able to do a static analysis on the RKD tasks and format it as a table. There may be a plugin needed.

What to include?

  • Class docstring with usage description
  • configure_argparse() catched object and parsed to list all defined options and arguments
  • List of environment variables from get_declared_envs()
@blackandred blackandred added this to the RKD 1.1 milestone Jun 16, 2020
@blackandred blackandred added the FEATURE New feature or request label Jun 16, 2020
@blackandred blackandred changed the title Documentation for switches of tasks Documentation for arguments, options and environment variables of tasks Jun 16, 2020
@blackandred blackandred modified the milestones: RKD 2.0, RKD 2.1 Jul 21, 2020
@blackandred blackandred modified the milestones: RKD 2.1, RKD 2.2, RKD 2.3 Aug 13, 2020
@blackandred blackandred modified the milestones: RKD 2.2, RKD 2.3 Oct 23, 2020
@blackandred blackandred modified the milestones: RKD 2.3, RKD 2.4 Nov 9, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FEATURE New feature or request
Projects
None yet
Milestone
RKD Next
Development

No branches or pull requests
1 participant
@blackandred