Skip to content

Nikola theme update and fixes - #11

Open
neofelis2X wants to merge 9 commits into
wxWidgets:masterfrom
neofelis2X:theme_update
Open

Nikola theme update and fixes#11
neofelis2X wants to merge 9 commits into
wxWidgets:masterfrom
neofelis2X:theme_update

Conversation

@neofelis2X

Copy link
Copy Markdown

Hello,

I updated the nikola theme to bootstrap v5 so that the page renders well and looks nice.

This is how the updated version looks like: https://wxpyweb-test.netlify.app

  • Bootstrap 5.3.8 overwrites Nikolas internal bootstrap 4 theme
  • Fontawesome updated to 7.3.1
  • Cleaned up image of the logo
  • New favicon and apple-touch-icon
  • Reformatted the bookshelf page
  • Sidebar is now loaded from conf.py and not hardcoded in the theme
  • Fixed a bunch of broken links
  • Updated versions of the actions in the github workflow. This should get rid of the warning that Node.js 20 actions are deprecated.

Hopefully this is helpful and please let me know if there are any other changes you would like to have implemented.

@echoix

echoix commented Jul 23, 2026

Copy link
Copy Markdown

It’s kinda hard to review a PR mixing multiple of different things, but at least you provide a live version to observe it working

@echoix echoix left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a couple questions and assumptions to verify

Comment thread pages/downloads.md Outdated
* Zip files with `*.pdb` files which are Visual Studio debugger information files.

* Binary wheel files for a few flavors of **Linux**.
* Binary wheel files for a few flavours of **Linux**.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before it was using US spelling, now it is UK/Canada/Australian spelling

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, US spelling then

Comment thread conf.py Outdated
# environment but is not recommended for HTTP/2.0 when caching is used.
# Defaults to True.
USE_BUNDLES = not USE_TEST_SITE
# !This seems to brake boostrap v5

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brake or break?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

break

Comment thread conf.py
# It can be anything, data, functions, modules, etc.
GLOBAL_CONTEXT = {
'header_logo': '<img src="/images/header-logo.png" />'
'example': '/images/header-logo.png'

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might understand later in the review, but is "example" expected here?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nikola has a dedicated variable LOGO_URL that is now used.
I just left a dummy entry in GLOBAL_CONTEXT

Comment thread pages/index.md
Comment on lines +1 to +7
<!--
.. title: Welcome to wxPython!
.. slug: index
.. tags:
.. link:
.. description: All about wxPython, the cross-platform GUI toolkit for the Python language
-->

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is usually yaml, it is called "front-matter", where you add some metadata that the website builder uses when creating html pages from markdown. I often see it with a separator after the end of that section.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nikola supports a variety of styles for front matter. This style is consistent with that of every other file in this folder.

Comment thread pages/maillists.md
experiences, etc. All questions that are Python specific should be asked here.<br>
[Mail Address](mailto:wxpython-users@googlegroups.com),
[Group URL](http://groups.google.com/group/wxpython-users)
[Group URL](https://groups.google.com/group/wxpython-users)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume here, and for all other http->https changes in this PR, that you tested that the server responds correctly. I still see some that don't work with https, which is another kind of problem.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, i mainly checked for dead links but also changed them to https in case they redirected.

Comment thread screenshots/transana-fullmultivid.jpg Outdated

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually, for screenshots (especially text), jpeg isn’t used because of the loss in quality of text and graphics. The gif used was an option that would be lossless if it fit in the palette restrictions, but there’s also .png that can be lossless and we often see in screenshots.

This applies to the multiple recompressed into jpeg files that are screenshots.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Websites usually care alot about filesizes. But I agree, in this case the lossless files should be kept.

Comment on lines +1 to +8
##
## A shortcode template to add a book to the bookshelf
##
## Expected Parameters:
## asin: number of book
## title: title of book
## img: path to the bookcover
##

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What file type (syntax) does tmpl files use? (To make sure lines starting with # are parsed as comments)

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nikola uses the mako template engine, in this case.

single line comment, two ##:
## this is a comment.

multi line comment:

<%doc>
    these are comments
    more comments
</%doc>

@@ -1,54 +1,159 @@
/*
* wxPython specific overrides for style items in the base and bootstrap3 themes.
* wxPython specific overrides for style items in the base and bootstrap4 themes.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bootstrap 4 or 5?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nikola provides a base-theme that uses bootstrap 4. The custom wxPython theme (now) overwrites it with bootstrap 5.

[Theme]
engine = mako
parent = bootstrap3
parent = bootstrap4

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4 or 5?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nikola provides a base-theme that uses bootstrap 4. The custom wxPython theme (now) overwrites it with bootstrap 5.

Comment thread conf.py

# Name of the theme to use.
#THEME = "bootstrap3"
#THEME = "bootstrap4"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

4 or 5?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nikola provides a base-theme that uses bootstrap 4. The custom wxPython theme (now) overwrites it with bootstrap 5.

@neofelis2X

Copy link
Copy Markdown
Author

It’s kinda hard to review a PR mixing multiple of different things, but at least you provide a live version to observe it working

I see. I can split it into smaller PR, if you like, Just didn't want to spam you.

@neofelis2X

Copy link
Copy Markdown
Author

I reverted the changed screenshots and the changed the two words back to US spelling. The incorrect comment in conf.py about USE_BUNDLES is now clarified.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants