Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes dagworks hub contrib docs #566

Merged
merged 1 commit into from
Nov 28, 2023
Merged
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
16 changes: 13 additions & 3 deletions contrib/docs/compile_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -215,15 +215,25 @@ def dataflows_with_everything(

<CodeBlock language="python">{{example2}}</CodeBlock>

### Modify for your needs
Now if you want to modify the dataflow, you can copy it to a new folder (renaming is possible), and modify it there.

<CodeBlock language="python">
dataflows.copy({DATAFLOW_NAME}, "path/to/save/to")
</CodeBlock>

<hr/>

{README}

## Source code
TODO: make collapsable.

import MyComponentSource from '!!raw-loader!./__init__.py';

<CodeBlock language="python">{{MyComponentSource}}</CodeBlock>

<details>
<summary>__init__.py</summary>
<CodeBlock language="python">{{MyComponentSource}}</CodeBlock>
</details>

## Requirements
import requirements from '!!raw-loader!./requirements.txt';
Expand Down