From 78b4f323fe523765755caa58e8ae4daf275e66d0 Mon Sep 17 00:00:00 2001 From: Joseph HENRY Date: Tue, 19 Mar 2024 18:58:39 +0100 Subject: [PATCH] docs additions --- README.md | 20 ++++++++++++++++---- docs/assets/logo_brunch_black.svg | 1 + docs/assets/logo_brunch_white.svg | 1 + docs/index.md | 7 +++++++ docs/overrides/partials/copyright.html | 16 ++++++++++++++++ mkdocs.yml | 1 + 6 files changed, 42 insertions(+), 4 deletions(-) create mode 100644 docs/assets/logo_brunch_black.svg create mode 100644 docs/assets/logo_brunch_white.svg create mode 100644 docs/overrides/partials/copyright.html diff --git a/README.md b/README.md index 20776b9..85b165c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![](https://img.shields.io/pypi/v/pytvpaint)](https://pypi.org/project/pytvpaint/) [![Downloads](https://static.pepy.tech/badge/pytvpaint/month)](https://pepy.tech/project/pytvpaint) [![](https://img.shields.io/pypi/pyversions/pytvpaint)](https://pypi.org/project/pytvpaint/) +[![](https://custom-icon-badges.demolab.com/badge/custom-11.5+-blue.svg?logo=butterfly_1f98b&label=TVPaint)](https://www.tvpaint.com/doc/tvp11/)

@@ -18,9 +19,14 @@ You can check the [documentation](https://brunchstudio.github.io/pytvpaint/) for ## Installation -First install the [TVPaint RPC plugin](https://brunchstudio.github.io/pytvpaint/installation/#tvpaint-plugin-installation). +### Requirements -Then install the package with Pip: +- Windows (for now, see [this](https://brunchstudio.github.io/pytvpaint/limitations/#windows-only)) +- Python v3.9+ +- TVPaint v11.5+ +- TVPaint RPC plugin (install instructions [here](https://brunchstudio.github.io/pytvpaint/installation/#tvpaint-plugin-installation)) + +Install the package with Pip: ```console ❯ pip install pytvpaint @@ -59,7 +65,11 @@ project.close() Pull requests are welcome. For major changes, please [open an issue](https://github.com/brunchstudio/pytvpaint/issues/new/choose) first to discuss what you would like to change. -Please make sure to update tests as appropriate. +Please make sure to [update tests](https://brunchstudio.github.io/pytvpaint/contributing/developer_setup/#unit-tests) as appropriate. + +## Disclaimer + +We are not affiliated with the TVPaint developers therefore we won't fix bugs in the software, PyTVPaint is a separate project created here at BRUNCH Studio to facilitate our developer experience. ## License @@ -67,4 +77,6 @@ Please make sure to update tests as appropriate.

-Made with ❤️ at [BRUNCH Studio](https://brunchstudio.tv/) 🥐🍳 +Made with ❤️ at + +[](https://brunchstudio.tv/) diff --git a/docs/assets/logo_brunch_black.svg b/docs/assets/logo_brunch_black.svg new file mode 100644 index 0000000..511f8ed --- /dev/null +++ b/docs/assets/logo_brunch_black.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/logo_brunch_white.svg b/docs/assets/logo_brunch_white.svg new file mode 100644 index 0000000..6d15511 --- /dev/null +++ b/docs/assets/logo_brunch_white.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 09207b1..5196caa 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,6 +5,7 @@ [![](https://img.shields.io/pypi/v/pytvpaint)](https://pypi.org/project/pytvpaint/) [![Downloads](https://static.pepy.tech/badge/pytvpaint/month)](https://pepy.tech/project/pytvpaint) [![](https://img.shields.io/pypi/pyversions/pytvpaint)](https://pypi.org/project/pytvpaint/) +[![](https://custom-icon-badges.demolab.com/badge/custom-11.5+-blue.svg?logo=butterfly_1f98b&label=TVPaint)](https://www.tvpaint.com/doc/tvp11/) PyTVPaint is a library that allows you to script for [TVPaint](https://www.tvpaint.com/) in Python instead of [George](https://www.tvpaint.com/doc/tvp11/index.php?id=lesson-advanced-functions-george-introduction). @@ -84,3 +85,9 @@ from pytvpaint import Layer for instance in Layer.current_layer().instances: print(instance.start, instance.name) ``` + +## Disclaimer + +!!! note + + We are not affiliated with the TVPaint developers therefore we won't fix bugs in the software, PyTVPaint is a separate project created here at BRUNCH Studio to facilitate our developer experience. diff --git a/docs/overrides/partials/copyright.html b/docs/overrides/partials/copyright.html new file mode 100644 index 0000000..62c9632 --- /dev/null +++ b/docs/overrides/partials/copyright.html @@ -0,0 +1,16 @@ +
+
+ Made with ❤️ at + + + + +
+
diff --git a/mkdocs.yml b/mkdocs.yml index 9f0a3ca..aa957eb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,6 +11,7 @@ copyright: Made with ❤️ by BRUNCH Studio developers theme: name: material + custom_dir: docs/overrides logo: assets/pytvpaint_logo.png favicon: assets/pytvpaint_logo.png icon: