Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file removed cloudquery/sdk/docs/__init__.py
Empty file.
145 changes: 0 additions & 145 deletions cloudquery/sdk/docs/generator.py

This file was deleted.

58 changes: 0 additions & 58 deletions cloudquery/sdk/docs/markdown_templates.py

This file was deleted.

42 changes: 1 addition & 41 deletions cloudquery/sdk/serve/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,9 @@
from cloudquery.plugin_v3 import plugin_pb2_grpc
from structlog import wrap_logger

from cloudquery.sdk.docs.generator import Generator
from cloudquery.sdk.internal.servers.discovery_v1.discovery import DiscoveryServicer
from cloudquery.sdk.internal.servers.plugin_v3 import PluginServicer
from cloudquery.sdk.plugin.plugin import Plugin, TableOptions

DOC_FORMATS = ["json", "markdown"]
from cloudquery.sdk.plugin.plugin import Plugin

_IS_WINDOWS = sys.platform == "win32"

Expand Down Expand Up @@ -136,34 +133,10 @@ def run(self, args):
help="network to serve on. can be tcp or unix",
)

doc_parser = subparsers.add_parser(
"doc",
formatter_class=argparse.RawTextHelpFormatter,
help="Generate documentation for tables",
description="""Generate documentation for tables.

If format is markdown, a destination directory will be created (if necessary) containing markdown files.
Example:
doc ./output

If format is JSON, a destination directory will be created (if necessary) with a single json file called __tables.json.
Example:
doc --format json .
""",
)
doc_parser.add_argument("directory", type=str)
doc_parser.add_argument(
"--format",
type=str,
default="json",
help="output format. one of: {}".format(",".join(DOC_FORMATS)),
)
parsed_args = parser.parse_args(args)

if parsed_args.command == "serve":
self._serve(parsed_args)
elif parsed_args.command == "doc":
self._generate_docs(parsed_args)
else:
parser.print_help()
sys.exit(1)
Expand All @@ -185,16 +158,3 @@ def _serve(self, args):

def stop(self):
self._server.stop(5)

def _generate_docs(self, args):
generator = Generator(
self._plugin.name(),
self._plugin.get_tables(
options=TableOptions(
tables=["*"],
skip_tables=[],
skip_dependent_tables=False,
)
),
)
generator.generate(args.directory, args.format)
Empty file removed tests/docs/__init__.py
Empty file.
9 changes: 0 additions & 9 deletions tests/docs/snapshots/README.md

This file was deleted.

12 changes: 0 additions & 12 deletions tests/docs/snapshots/test_table.md

This file was deleted.

20 changes: 0 additions & 20 deletions tests/docs/snapshots/test_table_child.md

This file was deleted.

15 changes: 0 additions & 15 deletions tests/docs/snapshots/test_table_composite_pk.md

This file was deleted.

15 changes: 0 additions & 15 deletions tests/docs/snapshots/test_table_grandchild.md

This file was deleted.

19 changes: 0 additions & 19 deletions tests/docs/snapshots/test_table_relations.md

This file was deleted.

Loading