-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
268 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
|
||
# Reference Overview | ||
|
||
[winter\_theme.\_\_init\_\_](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.\_\_init\_\_.md) | ||
<br> | ||
|
||
|
||
[winter\_theme.\_\_main\_\_](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.\_\_main\_\_.md) | ||
<br> | ||
|
||
|
||
[winter\_theme.hooking.\_\_init\_\_](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.hooking.\_\_init\_\_.md) | ||
<br> | ||
|
||
|
||
[winter\_theme.hooking.ante\_build\_hook](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.hooking.ante\_build\_hook.md) | ||
<br> | ||
|
||
|
||
[winter\_theme.hooking.ante\_release\_hook](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.hooking.ante\_release\_hook.md) | ||
<br> | ||
|
||
|
||
[winter\_theme.hooking.post\_build\_hook](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.hooking.post\_build\_hook.md) | ||
<br> | ||
|
||
|
||
[winter\_theme.hooking.post\_release\_hook](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.hooking.post\_release\_hook.md) | ||
<br> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
|
||
Back to [Reference Overview](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/README.md) | ||
|
||
# winter\_theme.\_\_init\_\_ | ||
|
||
|
||
|
||
<br> | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
|
||
Back to [Reference Overview](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/README.md) | ||
|
||
# winter\_theme.\_\_main\_\_ | ||
|
||
|
||
|
||
<br> | ||
|
||
|
||
```python | ||
|
||
def main(): | ||
""" | ||
""" | ||
|
||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
|
||
Back to [Reference Overview](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/README.md) | ||
|
||
# winter\_theme.hooking.\_\_init\_\_ | ||
|
||
|
||
|
||
<br> | ||
|
||
|
31 changes: 31 additions & 0 deletions
31
docs/reference/content/winter_theme.hooking.ante_build_hook.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
|
||
Back to [Reference Overview](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/README.md) | ||
|
||
# winter\_theme.hooking.ante\_build\_hook | ||
|
||
|
||
|
||
<br> | ||
|
||
|
||
```python | ||
|
||
def get_data(): | ||
""" | ||
Return None or a dict with the keys: | ||
'script', 'target', 'app_pkg' and 'version' | ||
""" | ||
|
||
``` | ||
|
||
<br> | ||
|
||
```python | ||
|
||
def main(): | ||
""" | ||
""" | ||
|
||
``` | ||
|
83 changes: 83 additions & 0 deletions
83
docs/reference/content/winter_theme.hooking.ante_release_hook.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
|
||
Back to [Reference Overview](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/README.md) | ||
|
||
# winter\_theme.hooking.ante\_release\_hook | ||
|
||
|
||
|
||
<br> | ||
|
||
|
||
```python | ||
TEXT = "Released with [Pyrustic]({pyrustic_link}). | ||
" | ||
|
||
``` | ||
|
||
<br> | ||
|
||
```python | ||
|
||
def get_data(): | ||
""" | ||
Return None or a dict with the keys: | ||
'script', 'target', 'app_pkg' and 'version' | ||
""" | ||
|
||
``` | ||
|
||
<br> | ||
|
||
```python | ||
|
||
def get_jayson(pyrustic_data_path, config_name, readonly): | ||
""" | ||
""" | ||
|
||
``` | ||
|
||
<br> | ||
|
||
```python | ||
|
||
def get_pyrustic_data_path(data): | ||
""" | ||
""" | ||
|
||
``` | ||
|
||
<br> | ||
|
||
```python | ||
|
||
def get_release_description(target, owner, repo): | ||
""" | ||
""" | ||
|
||
``` | ||
|
||
<br> | ||
|
||
```python | ||
|
||
def main(): | ||
""" | ||
""" | ||
|
||
``` | ||
|
||
<br> | ||
|
||
```python | ||
|
||
def update_release_jayson(target, release_jayson, build_report_jayson, app_pkg, version): | ||
""" | ||
""" | ||
|
||
``` | ||
|
31 changes: 31 additions & 0 deletions
31
docs/reference/content/winter_theme.hooking.post_build_hook.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
|
||
Back to [Reference Overview](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/README.md) | ||
|
||
# winter\_theme.hooking.post\_build\_hook | ||
|
||
|
||
|
||
<br> | ||
|
||
|
||
```python | ||
|
||
def get_data(): | ||
""" | ||
Return None or a dict with the keys: | ||
'script', 'target', 'app_pkg' and 'version' | ||
""" | ||
|
||
``` | ||
|
||
<br> | ||
|
||
```python | ||
|
||
def main(): | ||
""" | ||
""" | ||
|
||
``` | ||
|
54 changes: 54 additions & 0 deletions
54
docs/reference/content/winter_theme.hooking.post_release_hook.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
|
||
Back to [Reference Overview](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/README.md) | ||
|
||
# winter\_theme.hooking.post\_release\_hook | ||
|
||
|
||
|
||
<br> | ||
|
||
|
||
```python | ||
|
||
def get_data(): | ||
""" | ||
Return None or a dict with the keys: | ||
'script', 'target', 'app_pkg' and 'version' | ||
""" | ||
|
||
``` | ||
|
||
<br> | ||
|
||
```python | ||
|
||
def get_date(): | ||
""" | ||
Returns the current date. Format: Month day, year. | ||
Example: January 15, 2020 | ||
""" | ||
|
||
``` | ||
|
||
<br> | ||
|
||
```python | ||
|
||
def main(): | ||
""" | ||
""" | ||
|
||
``` | ||
|
||
<br> | ||
|
||
```python | ||
|
||
def update_changelog(path, data, version): | ||
""" | ||
Update the file CHANGELOG.md located at path, with data and version | ||
""" | ||
|
||
``` | ||
|