Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 11069a6

Browse files
committedFeb 17, 2024·
update docs generation process
1 parent f82bb0a commit 11069a6

File tree

2 files changed

+8
-11
lines changed

2 files changed

+8
-11
lines changed
 

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ _Note: Additional secret store options may be supported in the future. [More inf
1616
### Retrieving Secrets
1717

1818
```python
19-
from airbyte_lib import get_secret, SecretSource
19+
from airbyte import get_secret, SecretSource
2020

2121
source = get_connection("source-github")
2222
source.set_config(

‎docs/generate.py

+7-10
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,25 @@
1111

1212

1313
def run() -> None:
14-
"""Generate docs for all public modules in airbyte_lib and save them to docs/generated.
15-
16-
Public modules are:
17-
* The main airbyte_lib module
18-
* All directory modules in airbyte_lib that don't start with an underscore.
19-
"""
20-
public_modules = ["airbyte"]
14+
"""Generate docs for all public modules in AirbyteLib and save them to docs/generated."""
15+
public_modules = []
2116

2217
# recursively delete the docs/generated folder if it exists
2318
if pathlib.Path("docs/generated").exists():
2419
shutil.rmtree("docs/generated")
2520

26-
# All files and folders in `airbyte_lib` that don't start with "_" are treated as public.
21+
# All files and folders that don't start with "_" are treated as public.
2722
for submodule in os.listdir("airbyte"):
2823
submodule_path = pathlib.Path(f"airbyte/{submodule}")
2924
if not submodule.startswith("_"):
3025
public_modules.append(submodule_path)
3126

3227
pdoc.render.configure(
3328
template_directory="docs",
34-
show_source=False,
35-
search=False,
29+
show_source=True,
30+
search=True,
31+
logo="https://docs.airbyte.com/img/logo-dark.png",
32+
favicon="https://docs.airbyte.com/img/favicon.png",
3633
)
3734
pdoc.pdoc(
3835
*public_modules,

0 commit comments

Comments
 (0)
Please sign in to comment.