From eacae54f59b5cf749580cbb54d10f3984affe3b6 Mon Sep 17 00:00:00 2001 From: Eugenio Parodi Date: Mon, 10 May 2021 23:57:22 +0100 Subject: [PATCH] Improved the doc images --- Makefile | 5 +++-- TermTk/TTkCore/signal.py | 2 +- TermTk/TTkLayouts/__init__.py | 8 +++++++- docs/source/_static/Layout.HLD.001.svg | 1 - docs/source/_static/Signal.Slots.001.svg | 1 - 5 files changed, 11 insertions(+), 6 deletions(-) delete mode 120000 docs/source/_static/Layout.HLD.001.svg delete mode 120000 docs/source/_static/Signal.Slots.001.svg diff --git a/Makefile b/Makefile index 9b662907..8eddc1fc 100644 --- a/Makefile +++ b/Makefile @@ -14,11 +14,12 @@ doc: .venv # rm -rf docs/html ; \ # pdoc --html TermTk -o docs/html ; \ . .venv/bin/activate ; \ - rm -rf docs/html ; \ + rm -rf docs/build ; \ rm -rf docs/source/autogen.* ; \ # sphinx-apidoc -o docs/source/TermTk/ -e TermTk/ ; \ make -C docs/ clean ; \ - make -C docs/ html ; + make -C docs/ html ; \ + cp -a docs/images docs/build/html/_images ; runGittk: .venv . .venv/bin/activate ; \ diff --git a/TermTk/TTkCore/signal.py b/TermTk/TTkCore/signal.py index bddb1482..e926feb5 100644 --- a/TermTk/TTkCore/signal.py +++ b/TermTk/TTkCore/signal.py @@ -49,7 +49,7 @@ Signal and Slots | A slot is a function that is called in response to a particular signal. | `TermTk `_'s :mod:`~TermTk.TTkWidgets` have many predefined signals/slots, but it is possible to subclass any :mod:`~TermTk.TTkWidgets` and add our own signals/slots to them. -.. image:: /_static/Signal.Slots.001.svg +.. image:: /../_images/Signal.Slots.001.svg Methods ======= diff --git a/TermTk/TTkLayouts/__init__.py b/TermTk/TTkLayouts/__init__.py index fead494d..b921e528 100644 --- a/TermTk/TTkLayouts/__init__.py +++ b/TermTk/TTkLayouts/__init__.py @@ -1,3 +1,9 @@ +''' +Layouts +======= + +.. image:: /../_images/Layout.HLD.001.svg +''' from .layout import * from .gridlayout import * -from .boxlayout import * \ No newline at end of file +from .boxlayout import * diff --git a/docs/source/_static/Layout.HLD.001.svg b/docs/source/_static/Layout.HLD.001.svg deleted file mode 120000 index 77be4e97..00000000 --- a/docs/source/_static/Layout.HLD.001.svg +++ /dev/null @@ -1 +0,0 @@ -../../images/Layout.HLD.001.svg \ No newline at end of file diff --git a/docs/source/_static/Signal.Slots.001.svg b/docs/source/_static/Signal.Slots.001.svg deleted file mode 120000 index bfc8cfe1..00000000 --- a/docs/source/_static/Signal.Slots.001.svg +++ /dev/null @@ -1 +0,0 @@ -../../images/Signal.Slots.001.svg \ No newline at end of file