rdocs 0.1.2

Code Documentation Made Simple
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

```console
$ rdocs --help
Code Documentation Made Simple

Usage: rdocs [OPTIONS] [PATH] <COMMAND>

Commands:
  collect  Collect documentation blocks
  replace  Collect documentation blocks and replace with a given target
  help     Print this message or the help of the given subcommand(s)

Arguments:
  [PATH]  Source code directory for collecting documentation [default: .]

Options:
  -l, --log-level <LOG_LEVEL>  Log level [default: INFO]
  -c, --config <CONFIG>        Source code directory for collecting documentation
  -h, --help                   Print help
  -V, --version                Print version

```

```console
$ rdocs collect --help
Collect documentation blocks

Usage: rdocs collect [OPTIONS] [PATH]

Arguments:
  [PATH]
          Source code directory for collecting documentation
          
          [default: .]

Options:
  -l, --log-level <LOG_LEVEL>
          Log level
          
          [default: INFO]

  -o, --output <OUTPUT>
          Save result to the given file. if not provided the results will print to the stdout 

  -c, --config <CONFIG>
          Source code directory for collecting documentation

  -f, --format <FORMAT>
          Result output

          Possible values:
          - json: Export in JSON format
          - yaml: Export in YAML format

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

```