Skip to content

Commit 1a03e6c

Browse files
committed
[README.md] Link proof of concept for doc gen
1 parent 37692eb commit 1a03e6c

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ cdd-python
1212
[![PyPi: release](https://img.shields.io/pypi/v/python-cdd.svg?maxAge=3600)](https://pypi.org/project/python-cdd)
1313
[![hosted documentation](https://img.shields.io/badge/hosted-docs-white)](https://offscale.io/cdd-python/)
1414

15-
[OpenAPI](https://openapis.org) to/fro routes, models, and tests. Convert between docstrings, `class`es, methods, [argparse](https://docs.python.org/3/library/argparse.html), pydantic, and [SQLalchemy](https://sqlalchemy.org).
15+
[OpenAPI](https://openapis.org) to/fro routes, models, and tests. Convert between docstrings, `class`es,
16+
methods, [argparse](https://docs.python.org/3/library/argparse.html), pydantic,
17+
and [SQLalchemy](https://sqlalchemy.org).
1618

1719
Public SDK works with filenames, source code, and even in memory constructs (e.g., as imported into your REPL).
1820

@@ -81,7 +83,12 @@ To break it down, with current tooling there is no way to know:
8183
Some of these problems can be solved dynamically, however in doing so one loses developer-tool insights.
8284
There is no code-completion, and likely the CLI parser won't provide you with the enumeration of possibilities.
8385

84-
For migration from Google App Engine, this project builds upon cdd-python for a unidirectional experience: https://github.com/offscale/cdd-python-gae
86+
For migration from Google App Engine, this project builds upon cdd-python for a unidirectional
87+
experience: https://github.com/offscale/cdd-python-gae
88+
89+
Also, a proof-of-concept was made
90+
to [generate documentation using cdd-python](https://github.com/SamuelMarks/griffe/tree/rest) (`mkdocs` core
91+
replacement).
8592

8693
## SDK example (REPL)
8794

@@ -718,7 +725,8 @@ PS: If you're outputting JSON-schema and want a file per schema then:
718725
--dry-run Show what would be created; don't actually write to
719726
the filesystem.
720727

721-
PS: Below is a temporary hack to run on the SQLalchemy output to make it work; until the `tuple`|`Tuple`|`List`|`list`|`name` as column-type bug is resolved:
728+
PS: Below is a temporary hack to run on the SQLalchemy output to make it work; until the `tuple`|`Tuple`|`List`|`list`|
729+
`name` as column-type bug is resolved:
722730

723731
fastmod --accept-all -iF 'tuple, comment=' 'LargeBinary, comment=' ; fastmod --accept-all -iF 'tuple,
724732
comment=' 'LargeBinary, comment=' ; fastmod --accept-all -iF 'list, comment=' 'LargeBinary, comment=' ; fastmod --accept-all -iF 'list,

0 commit comments

Comments
 (0)