Merge pull request #13 from ceccopierangiolieugenio/Use_Sphinx_Doc_Generator

Use sphinx doc generator

Makefile

@@ -42,9 +42,9 @@ buildTest: .venv
 
 deployDoc:
 	git checkout gh-pages
-	rm -rf *.inv *.html *.js _* autogen.*
+	rm -rf *.inv *.html *.js _* autogen.* tutorial
 	cp -a docs/build/html/* .
-	find *.html *.inv *.js autogen.TermTk _* | xargs git add
+	find *.html *.inv *.js autogen.TermTk _* tutorial | xargs git add
 	git commit -m "Doc Updated"
 	git push origin gh-pages
 	git checkout main

docs/source/_static/theme_overrides.css

@@ -19,8 +19,9 @@
       overflow: visible !important;
    }
 
+   /* Piercecco's Workaround */
    .wy-menu p {
-      color: #55a5d9;
+      color: #66a5d9;
       height: 32px;
       line-height: 32px;
       padding: 0 1.618em;
@@ -31,5 +32,18 @@
       font-size: 85%;
       white-space: nowrap;
    }
+   /* Piercecco's Workaround */
+   .toctree-wrapper p {
+      color: #175ba9;
+      height: 32px;
+      line-height: 32px;
+      padding: 0;
+      margin: 12px 0 0;
+      display: block;
+      font-weight: 700;
+      text-transform: uppercase;
+      font-size: 85%;
+      white-space: nowrap;
+   }
 }
 

docs/source/index.rst

@@ -17,8 +17,9 @@ Welcome to pyTermTk's documentation!
 Intro
 -----
 
-pyTermTk_ is a Text-based user interface library (TUI_)
-Evolved from the discontinued project pyCuT_ and inspired by a mix of Qt5_, GTK_, and tkinter_ api definition with a touch of personal interpretation
+| pyTermTk_ is a Text-based user interface library (TUI_)
+| Evolved from the discontinued project pyCuT_ and inspired by
+| a mix of Qt5_, GTK_, and tkinter_ api definition with a touch of personal interpretation
 
 
 .. toctree::

tutorial/001-helloworld.rst

@@ -23,7 +23,7 @@ Examples
 Example 1
 ---------
 
-Following is the code to execute `helloworld.001.py <helloworld/helloworld.001.py>`_ in pyTermTk_:
+Following is the code to execute `helloworld.001.py <https://github.com/ceccopierangiolieugenio/pyTermTk/blob/main/tutorial/helloworld/helloworld.001.py>`_ in pyTermTk_:
 
 .. code:: python
 
@@ -42,7 +42,7 @@ The above code produces the following output
 Example 2 - Your first Window
 -----------------------------
 
-Following is the code to execute `helloworld.002.py <helloworld/helloworld.002.py>`_ in pyTermTk_:
+Following is the code to execute `helloworld.002.py <https://github.com/ceccopierangiolieugenio/pyTermTk/blob/main/tutorial/helloworld/helloworld.002.py>`_ in pyTermTk_:
 
 .. code:: python
 

tutorial/002-layout.rst

@@ -1,11 +1,11 @@
 .. _pyTermTk:       https://github.com/ceccopierangiolieugenio/pyTermTk
-.. _windows:        https://ceccopierangiolieugenio.github.io/pyTermTk/TTkWidgets/window.html
-.. _TTkLabel:       https://ceccopierangiolieugenio.github.io/pyTermTk/autogen.TermTk/TermTk.TTkWidgets.label.html#TermTk.TTkWidgets.label.TTkLabel
-.. _TTkLayouts:     https://ceccopierangiolieugenio.github.io/pyTermTk/TTkLayouts/index.html
-.. _TTkLayout:      https://ceccopierangiolieugenio.github.io/pyTermTk/TTkLayouts/layout.html#TermTk.TTkLayouts.layout.TTkLayout
-.. _TTkHBoxLayout:  https://ceccopierangiolieugenio.github.io/pyTermTk/TTkLayouts/boxlayout.html#TermTk.TTkLayouts.boxlayout.TTkHBoxLayout
-.. _TTkVBoxLayout:  https://ceccopierangiolieugenio.github.io/pyTermTk/TTkLayouts/boxlayout.html#TermTk.TTkLayouts.boxlayout.TTkVBoxLayout
-.. _TTkGridLayout:  https://ceccopierangiolieugenio.github.io/pyTermTk/TTkLayouts/gridlayout.html#TermTk.TTkLayouts.gridlayout.TTkGridLayout
+.. _windows:        https://ceccopierangiolieugenio.github.io/pyTermTk/autogen.TermTk/TermTk.TTkWidgets.window.html
+.. _TTkLabel:       https://ceccopierangiolieugenio.github.io/pyTermTk/autogen.TermTk/TermTk.TTkWidgets.label.html
+.. _TTkLayouts:     https://ceccopierangiolieugenio.github.io/pyTermTk/autogen.TermTk/TermTk.TTkLayouts.html
+.. _TTkLayout:      https://ceccopierangiolieugenio.github.io/pyTermTk/autogen.TermTk/TermTk.TTkLayouts.layout.html#ttklayout
+.. _TTkHBoxLayout:  https://ceccopierangiolieugenio.github.io/pyTermTk/autogen.TermTk/TermTk.TTkLayouts.boxlayout.html#ttkhboxlayout
+.. _TTkVBoxLayout:  https://ceccopierangiolieugenio.github.io/pyTermTk/autogen.TermTk/TermTk.TTkLayouts.boxlayout.html#ttkvboxlayout
+.. _TTkGridLayout:  https://ceccopierangiolieugenio.github.io/pyTermTk/autogen.TermTk/TermTk.TTkLayouts.gridlayout.html#ttkgridlayout
 
 .. _Layout Example:         https://github.com/ceccopierangiolieugenio/pyTermTk/blob/main/tutorial/layout/example1.simple.layout.py
 .. _VBox Example:           https://github.com/ceccopierangiolieugenio/pyTermTk/blob/main/tutorial/layout/example2.simple.vbox.py