Browse Source

Updates stuff for doc

pull/278/head
Eugenio Parodi 1 year ago
parent
commit
1257336c12
  1. 1
      .gitignore
  2. 44
      Makefile
  3. 9
      TermTk/TTkGui/textdocument.py
  4. 4
      TermTk/TTkTemplates/__init__.py
  5. 2
      TermTk/TTkTemplates/dragevents.py
  6. 2
      TermTk/TTkTemplates/keyevents.py
  7. 2
      TermTk/TTkTemplates/mouseevents.py
  8. 3
      docs/source/index.rst
  9. 2
      docs/source/sphinx_modules/sphinx_ext_autosummary_reworked.py

1
.gitignore vendored

@ -4,6 +4,7 @@ __pycache__/
*$py.class
# other
pyTermTk-Docs
tests/test.dummy.py
*.swp
*.zip

44
Makefile

@ -22,21 +22,13 @@
pip install pyperclip Pillow
doc: .venv
# old doc gen, using pdoc3 ; \
# . .venv/bin/activate ; \
# rm -rf docs/html ; \
# pdoc --html TermTk -o docs/html ; \
. .venv/bin/activate ; \
tools/prepareBuild.sh doc ; \
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 ; \
cp -a docs/images docs/build/html/_images ;
make -C docs/source/ clean ; \
make -C docs/source/ html ;
testDoc:
python3 -m http.server --directory docs/build/html/
python3 -m http.server --directory docs/source/_build/html/
runTtkDesigner: .venv.ttkDesigner
. .venv.ttkDesigner/bin/activate ; \
@ -86,17 +78,25 @@ deployTTkDesigner: .venv
. .venv/bin/activate ; \
python3 -m twine upload tmp/dist/*
deployDoc:
git checkout gh-pages
# Update the doc files
rm -rf *.inv *.html *.js _* autogen.* tutorial info
cp -a docs/build/html/* .
find *.html *.inv *.js autogen.TermTk _* tutorial info | xargs git add
git commit -m "Doc Updated"
git push origin gh-pages
git checkout main
pyTermTk-Docs:
git clone git@github.com:ceccopierangiolieugenio/pyTermTk-Docs.git
deployDoc: pyTermTk-Docs
cd pyTermTk-Docs ; \
git checkout main ; \
git pull ; \
rm -rf _* info tutorial ; \
cp -a ../docs/source/_build/html/* \
../docs/source/_build/html/.buildinfo \
../docs/source/_build/html/.nojekyll \
. ; \
git add . ; \
git commit -m "Updated Docs" ; \
git push origin main ; \
git checkout gh-pages ; \
git merge main ; \
git push origin gh-pages ; \
echo "Docs Deployed!!!"
deploySandbox:
rm -rf tmp/sandbox

9
TermTk/TTkGui/textdocument.py

@ -31,12 +31,18 @@ class TTkTextDocument():
Undo,Redo Logic
Old:
::
_snapshotId: = last saved/undo/redo state
3 = doc4
_snapshots:
[doc1, doc2, doc3, doc4, doc5, doc6, . . .]
New:
::
SnapshotId:
2
Snapshots: _lastSnap _dataLines (unstaged)
@ -51,6 +57,8 @@ class TTkTextDocument():
Slices: = common txt slices between snapshots
[ s01, s12, s23, s34 ]
::
Data Structure
Snapshot B > Snapshot C
@ -67,6 +75,7 @@ class TTkTextDocument():
'''
class _snapDiff():
'''

4
TermTk/TTkTemplates/__init__.py

@ -1 +1,5 @@
# from .lookandfeel import TTkLookAndFeel
from .dragevents import *
from .keyevents import *
from .mouseevents import *

2
TermTk/TTkTemplates/dragevents.py

@ -20,6 +20,8 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
__all__ = ['TDragEvents']
class TDragEvents():
def dragEnterEvent(self, evt) -> bool:
'''

2
TermTk/TTkTemplates/keyevents.py

@ -20,6 +20,8 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
__all__ = ['TKeyEvents']
from TermTk.TTkCore.TTkTerm.inputkey import TTkKeyEvent
class TKeyEvents():

2
TermTk/TTkTemplates/mouseevents.py

@ -20,6 +20,8 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
__all__ = ['TMouseEvents']
from TermTk.TTkCore.TTkTerm.inputmouse import TTkMouseEvent
class TMouseEvents():

3
docs/source/index.rst

@ -108,10 +108,13 @@ API Reference
.. # :template: custom-class-template.01.rst
.. #
.. # TTkCore.TTkK
.. #
.. # TTkWidgets.TTkAppTemplate
.. # TTkWidgets.TTkMenuBar
.. # TTkWidgets.TTkMenuBarLayout
.. # TTkWidgets.TTkWidget
.. # TTkWidgets.TTkLineEdit
.. # TTkWidgets.TTkScrollBar
.. # TTkWidgets.TTkModelView.TTkTable

2
docs/source/sphinx_modules/sphinx_ext_autosummary_reworked.py

@ -160,7 +160,7 @@ def setup(app: Sphinx) -> ExtensionMetadata:
def _parseModules(_mod):
if _file:=getattr(_mod,'__file__',None):
if '__init__.py' in _file and '/TermTk/' in _file:
if ('__init__.py' in _file and '/TermTk/' in _file ):
# print(_file)
for _name, _obj in inspect.getmembers(_mod):
if _mod.__name__ == 'TermTk.TTkCore.drivers': continue

Loading…
Cancel
Save