Update internal docs related to DipDup config (#257)

* Update internal docs related to DipDup config

* Lint

* drop --hashes;

* More docs

* Lint

* Contribution, docstring script

Author: droserasprout

CHANGELOG.md

@@ -1,7 +1,5 @@
 # Changelog
 
-Please use [this](https://docs.gitlab.com/ee/development/changelog.html) document as guidelines to keep a changelog.
-
 ## [unreleased]
 
 ### Added
@@ -18,6 +16,7 @@ Please use [this](https://docs.gitlab.com/ee/development/changelog.html) documen
 
 * config: Removed dummy `advanced.oneshot` flag.
 * cli: Removed `docker init` command.
+* cli: Removed dummy `schema approve --hashes` flag.
 
 ## 5.0.0-rc2 - 2022-03-13
 

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# DipDup contribution guide
+
+## Codestyle
+
+## Releases
+
+## Documentation
+
+* All changes that affect user experience MUST be documented in CHANGELOG.md file.
+* Changelog formatting SHOULD stick to GitLab changelog [guidelines](https://docs.gitlab.com/ee/development/changelog.html).

scripts/extract_reference.py

@@ -0,0 +1,22 @@
+import importlib
+
+config_module = importlib.import_module('dipdup.config')
+for name, member in config_module.__dict__.items():
+    if not name.endswith('Config'):
+        continue
+    if isinstance(member, type):
+        doc = member.__doc__
+        if not doc:
+            continue
+
+        print()
+        print(f'=> {name}')
+        print()
+        print('| field | description |')
+        print('| - | - |')
+        for line in doc.split('\n'):
+            line = line.strip()
+            if line.startswith(':param'):
+                parts = line.split(':')
+                param, desc = parts[1], parts[2].strip()
+                print(f'| `{param[6:]}` | {desc} |')

src/dipdup/cli.py

@@ -5,7 +5,6 @@
 import signal
 import subprocess
 import sys
-import warnings
 from contextlib import AsyncExitStack
 from contextlib import suppress
 from dataclasses import dataclass
@@ -320,13 +319,9 @@ async def schema(ctx):
 
 
 @schema.command(name='approve', help='Continue to use existing schema after reindexing was triggered')
-@click.option('--hashes', is_flag=True, help='Recalculate all schema and config hashes')
 @click.pass_context
 @cli_wrapper
-async def schema_approve(ctx, hashes: bool):
-    if hashes:
-        warnings.warn('`--hashes` option is deprecated and has no effect', DeprecationWarning)
-
+async def schema_approve(ctx):
     config: DipDupConfig = ctx.obj.config
     url = config.database.connection_string
     models = f'{config.package}.models'