From 5617d441c4d73ceda4c2bb6fbd0f0bf306e41494 Mon Sep 17 00:00:00 2001 From: Pyrustic Evangelist Date: Tue, 22 Jun 2021 23:28:42 +0100 Subject: [PATCH] Update --- docs/reference/README.md | 30 +++++++ .../content/winter_theme.__init__.md | 10 +++ .../content/winter_theme.__main__.md | 19 +++++ .../content/winter_theme.hooking.__init__.md | 10 +++ .../winter_theme.hooking.ante_build_hook.md | 31 +++++++ .../winter_theme.hooking.ante_release_hook.md | 83 +++++++++++++++++++ .../winter_theme.hooking.post_build_hook.md | 31 +++++++ .../winter_theme.hooking.post_release_hook.md | 54 ++++++++++++ 8 files changed, 268 insertions(+) create mode 100644 docs/reference/README.md create mode 100644 docs/reference/content/winter_theme.__init__.md create mode 100644 docs/reference/content/winter_theme.__main__.md create mode 100644 docs/reference/content/winter_theme.hooking.__init__.md create mode 100644 docs/reference/content/winter_theme.hooking.ante_build_hook.md create mode 100644 docs/reference/content/winter_theme.hooking.ante_release_hook.md create mode 100644 docs/reference/content/winter_theme.hooking.post_build_hook.md create mode 100644 docs/reference/content/winter_theme.hooking.post_release_hook.md diff --git a/docs/reference/README.md b/docs/reference/README.md new file mode 100644 index 0000000..87ea983 --- /dev/null +++ b/docs/reference/README.md @@ -0,0 +1,30 @@ + +# Reference Overview + +[winter\_theme.\_\_init\_\_](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.\_\_init\_\_.md) +
+ + +[winter\_theme.\_\_main\_\_](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.\_\_main\_\_.md) +
+ + +[winter\_theme.hooking.\_\_init\_\_](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.hooking.\_\_init\_\_.md) +
+ + +[winter\_theme.hooking.ante\_build\_hook](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.hooking.ante\_build\_hook.md) +
+ + +[winter\_theme.hooking.ante\_release\_hook](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.hooking.ante\_release\_hook.md) +
+ + +[winter\_theme.hooking.post\_build\_hook](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.hooking.post\_build\_hook.md) +
+ + +[winter\_theme.hooking.post\_release\_hook](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/content/winter\_theme.hooking.post\_release\_hook.md) +
+ diff --git a/docs/reference/content/winter_theme.__init__.md b/docs/reference/content/winter_theme.__init__.md new file mode 100644 index 0000000..5a670ba --- /dev/null +++ b/docs/reference/content/winter_theme.__init__.md @@ -0,0 +1,10 @@ + +Back to [Reference Overview](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/README.md) + +# winter\_theme.\_\_init\_\_ + + + +
+ + diff --git a/docs/reference/content/winter_theme.__main__.md b/docs/reference/content/winter_theme.__main__.md new file mode 100644 index 0000000..200ec41 --- /dev/null +++ b/docs/reference/content/winter_theme.__main__.md @@ -0,0 +1,19 @@ + +Back to [Reference Overview](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/README.md) + +# winter\_theme.\_\_main\_\_ + + + +
+ + +```python + +def main(): + """ + + """ + +``` + diff --git a/docs/reference/content/winter_theme.hooking.__init__.md b/docs/reference/content/winter_theme.hooking.__init__.md new file mode 100644 index 0000000..79c9ec5 --- /dev/null +++ b/docs/reference/content/winter_theme.hooking.__init__.md @@ -0,0 +1,10 @@ + +Back to [Reference Overview](https://github.com/pyrustic/winter-theme/blob/master/docs/reference/README.md) + +# winter\_theme.hooking.\_\_init\_\_ + + + +
+ + diff --git a/docs/reference/content/winter_theme.hooking.ante_build_hook.md b/docs/reference/content/winter_theme.hooking.ante_build_hook.md new file mode 100644 index 0000000..fbae269 --- /dev/null +++ b/docs/reference/content/winter_theme.hooking.ante_build_hook.md @@ -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 + + + +
+ + +```python + +def get_data(): + """ + Return None or a dict with the keys: + 'script', 'target', 'app_pkg' and 'version' + """ + +``` + +
+ +```python + +def main(): + """ + + """ + +``` + diff --git a/docs/reference/content/winter_theme.hooking.ante_release_hook.md b/docs/reference/content/winter_theme.hooking.ante_release_hook.md new file mode 100644 index 0000000..0bafdb4 --- /dev/null +++ b/docs/reference/content/winter_theme.hooking.ante_release_hook.md @@ -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 + + + +
+ + +```python +TEXT = "Released with [Pyrustic]({pyrustic_link}). +" + +``` + +
+ +```python + +def get_data(): + """ + Return None or a dict with the keys: + 'script', 'target', 'app_pkg' and 'version' + """ + +``` + +
+ +```python + +def get_jayson(pyrustic_data_path, config_name, readonly): + """ + + """ + +``` + +
+ +```python + +def get_pyrustic_data_path(data): + """ + + """ + +``` + +
+ +```python + +def get_release_description(target, owner, repo): + """ + + """ + +``` + +
+ +```python + +def main(): + """ + + """ + +``` + +
+ +```python + +def update_release_jayson(target, release_jayson, build_report_jayson, app_pkg, version): + """ + + """ + +``` + diff --git a/docs/reference/content/winter_theme.hooking.post_build_hook.md b/docs/reference/content/winter_theme.hooking.post_build_hook.md new file mode 100644 index 0000000..eb7e4a4 --- /dev/null +++ b/docs/reference/content/winter_theme.hooking.post_build_hook.md @@ -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 + + + +
+ + +```python + +def get_data(): + """ + Return None or a dict with the keys: + 'script', 'target', 'app_pkg' and 'version' + """ + +``` + +
+ +```python + +def main(): + """ + + """ + +``` + diff --git a/docs/reference/content/winter_theme.hooking.post_release_hook.md b/docs/reference/content/winter_theme.hooking.post_release_hook.md new file mode 100644 index 0000000..98361b2 --- /dev/null +++ b/docs/reference/content/winter_theme.hooking.post_release_hook.md @@ -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 + + + +
+ + +```python + +def get_data(): + """ + Return None or a dict with the keys: + 'script', 'target', 'app_pkg' and 'version' + """ + +``` + +
+ +```python + +def get_date(): + """ + Returns the current date. Format: Month day, year. + Example: January 15, 2020 + """ + +``` + +
+ +```python + +def main(): + """ + + """ + +``` + +
+ +```python + +def update_changelog(path, data, version): + """ + Update the file CHANGELOG.md located at path, with data and version + """ + +``` +