Fix error in Window docs (#520)

* add set box borders example * #492 Fixed in docs-src ONLY - please regen docs * Add pyproject.toml #495 * Docs style update * Add `step` to Slider, + tests + docs (#511) * Remove deprecated PIL method * Update dev instructions and add requirements.txt * Add missing text properties to text derived widgets and containers (weight, slant, underline & overstrike) (#506) * feat: add weight to Text derived widgets * test: add tests for Texts * docs: update docs for Text * feat: add weight to Drawing.text * test: add weight and color tests for Drawing.text * docs: add weight to Drawing.text * test: move weight_text_test into text_test * feat: add slant to Text derived widgets * test: fix tests for weight and add slant * docs: update for weight and slant * feat: add underline and overstrike to Text derived widgets * test: add tests for underline and overstrike * refactor: cast font properties into a tuple when passing to _set_tk_config * docs: update docs for underline and overstrike * fix: change weight to bold booleans and slant to italic booleans --------- Co-authored-by: Laura Sach <[email protected]> * Bump version * Generate docs via mkdocs gh-deploy instead * Change docs and add changelog * remove DS_Store files * Change version to 1.6.0 * Change version no in pyproject.toml too * Edit changelog * Move mkdocs.yml into main folder so it can be deployed * Fix broken image * Make even with master (#519) * Add slider increment, add bold etc text, change deployment method and move docs to gh-deploy (#514) * add set box borders example * #492 Fixed in docs-src ONLY - please regen docs * Add pyproject.toml #495 * Docs style update * Add `step` to Slider, + tests + docs (#511) * Remove deprecated PIL method * Update dev instructions and add requirements.txt * Add missing text properties to text derived widgets and containers (weight, slant, underline & overstrike) (#506) * feat: add weight to Text derived widgets * test: add tests for Texts * docs: update docs for Text * feat: add weight to Drawing.text * test: add weight and color tests for Drawing.text * docs: add weight to Drawing.text * test: move weight_text_test into text_test * feat: add slant to Text derived widgets * test: fix tests for weight and add slant * docs: update for weight and slant * feat: add underline and overstrike to Text derived widgets * test: add tests for underline and overstrike * refactor: cast font properties into a tuple when passing to _set_tk_config * docs: update docs for underline and overstrike * fix: change weight to bold booleans and slant to italic booleans --------- Co-authored-by: Laura Sach <[email protected]> * Bump version * Generate docs via mkdocs gh-deploy instead * Change docs and add changelog * remove DS_Store files * Change version to 1.6.0 * Change version no in pyproject.toml too * Edit changelog --------- Co-authored-by: Martin O'Hanlon <[email protected]> Co-authored-by: james-pcdr <[email protected]> Co-authored-by: Blindstars <[email protected]> * Fix broken image (#516) --------- Co-authored-by: Martin O'Hanlon <[email protected]> Co-authored-by: james-pcdr <[email protected]> Co-authored-by: Blindstars <[email protected]> * Fix broken docs --------- Co-authored-by: Martin O'Hanlon <[email protected]> Co-authored-by: james-pcdr <[email protected]> Co-authored-by: Blindstars <[email protected]>
lawsie · Mar 4, 2025 · 75948da · 75948da
1 parent 4aeebee
commit 75948da
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 6 deletions.
diff --git a/docs/window.md b/docs/window.md
@@ -112,7 +112,7 @@ Create an `Window` object by calling the `Window()` constructor. You should give
 ```python
 from guizero import App, Window
 app = App(title="My app", height=300, width=200)
-window = Window(app, title = "2nd Window", height=300, width=200)
+window = Window(app, title="A new Window", height=300, width=200)
 app.display()
 ```
 
@@ -124,13 +124,13 @@ app.display()
 from guizero import App, Window, PushButton
 
 def open_window():
-    window_2.show()
+    window.show()
 
 app = App(title="My app", height=300, width=200)
-window = Window(app, title = "2nd Window", height=300, width=200)
-window.hide()
+button = PushButton(app, text="Show second window", command=open_window)
 
-open_button(app, text="open 2nd window", command=open_window)
+window = Window(app, title="A new Window", height=300, width=200)
+window.hide()
 
 app.display()
 ```
@@ -139,5 +139,5 @@ If you want a `Window` to become the main window and stop all other windows resp
 
 ```python
 def open_window():
-    window_2.show(wait = True)
+    window.show(wait=True)
 ```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,46 @@
+site_name: guizero
+theme:
+  name: 'litera'
+extra_css: [extra.css]
+nav:
+  - About: about.md
+  - Installation: index.md
+  - Using guizero:
+      - Getting started: start.md
+      - Using Widgets: usingwidgets.md
+      - Commands: commands.md
+      - Multiple windows: multiple_windows.md
+      - Layouts: layout.md
+      - Pop-ups: alerts.md
+      - Sizes: size.md
+      - Colors: colors.md
+      - Images: images.md
+      - Loops and sleeping: blocking.md
+      - Events: events.md
+      - Using tkinter: usingtk.md
+      - Getting help: gettinghelp.md
+  - Widgets:
+      - Overview: widgetoverview.md
+      - App: app.md
+      - Box: box.md
+      - ButtonGroup: buttongroup.md
+      - CheckBox: checkbox.md
+      - Combo: combo.md
+      - Drawing: drawing.md
+      - ListBox: listbox.md
+      - MenuBar: menubar.md
+      - Picture: picture.md
+      - PushButton: pushbutton.md
+      - Slider: slider.md
+      - Text: text.md
+      - TextBox: textbox.md
+      - TitleBox: titlebox.md
+      - Waffle: waffle.md
+      - Window: window.md
+  - Recipes: recipes.md
+  - Book : book.md
+  - Contributing:
+      - Notes: contributing.md
+      - Developing: development.md
+      - Deploying: deployment.md
+  - Change log: changelog.md