Skip to content

Commit

Permalink
Initial commit of auto generated docs for subcommands
Browse files Browse the repository at this point in the history
  • Loading branch information
crossjam committed Oct 24, 2023
1 parent 9b062d3 commit f5ee5a6
Show file tree
Hide file tree
Showing 4 changed files with 105 additions and 0 deletions.
31 changes: 31 additions & 0 deletions subcommands/entries.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Entries
<!-- [[[cog
import cog
from feedbin_tools import cli
from click.testing import CliRunner
runner = CliRunner()
result = runner.invoke(cli.cli, ["entries", "--help"])
help = result.output.replace("Usage: cli", "Usage: feedbin-tools")
cog.out(
"```\n{}\n```".format(help)
)
]]] -->
```
Usage: feedbin-tools entries [OPTIONS]
Fetch entries for the authed feedbin user and emit as JSON
Options:
--read / --unread
--starred / --no-starred
--extended / --no-extended
--limit INTEGER
-b, --per-page INTEGER
--since TEXT Return entries after this date
--include-original / --no-include-original
--include-enclosure / --no-include-enclosure
--include-content-diff / --no-include-content-diff
--help Show this message and exit.
```
<!-- [[[end]]] -->
24 changes: 24 additions & 0 deletions subcommands/feed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Entries
<!-- [[[cog
import cog
from feedbin_tools import cli
from click.testing import CliRunner
runner = CliRunner()
result = runner.invoke(cli.cli, ["feed", "--help"])
help = result.output.replace("Usage: cli", "Usage: feedbin-tools")
cog.out(
"```\n{}\n```".format(help)
)
]]] -->
```
Usage: feedbin-tools feed [OPTIONS] FEED_ID
Fetch entries for feedbin feed FEED_ID and emit as JSON
Options:
--extended / --no-extended
--limit INTEGER
--help Show this message and exit.
```
<!-- [[[end]]] -->
26 changes: 26 additions & 0 deletions subcommands/starred.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Entries
<!-- [[[cog
import cog
from feedbin_tools import cli
from click.testing import CliRunner
runner = CliRunner()
result = runner.invoke(cli.cli, ["starred", "--help"])
help = result.output.replace("Usage: cli", "Usage: feedbin-tools")
cog.out(
"```\n{}\n```".format(help)
)
]]] -->
```
Usage: feedbin-tools starred [OPTIONS]
Fetch feedbin starred entries for the authed feedbin user and emit as JSON
Options:
-b, --chunk-size INTEGER
--extended / --no-extended
--ids / --no-ids
--limit INTEGER
--help Show this message and exit.
```
<!-- [[[end]]] -->
24 changes: 24 additions & 0 deletions subcommands/subscriptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Entries
<!-- [[[cog
import cog
from feedbin_tools import cli
from click.testing import CliRunner
runner = CliRunner()
result = runner.invoke(cli.cli, ["subscriptions", "--help"])
help = result.output.replace("Usage: cli", "Usage: feedbin-tools")
cog.out(
"```\n{}\n```".format(help)
)
]]] -->
```
Usage: feedbin-tools subscriptions [OPTIONS]
Fetch feedbin subscriptions for the authed feedbin user and emit as JSON
Options:
--since TEXT Return entries after this date
--extended / --no-extended Include extended information
--help Show this message and exit.
```
<!-- [[[end]]] -->

0 comments on commit f5ee5a6

Please sign in to comment.