Skip to content

Formatting of online documentation home page for 4.2.2 is a bit compact. #2608

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ghost opened this issue Sep 12, 2024 · 6 comments · Fixed by #2695
Closed

Formatting of online documentation home page for 4.2.2 is a bit compact. #2608

ghost opened this issue Sep 12, 2024 · 6 comments · Fixed by #2695

Comments

@ghost
Copy link

ghost commented Sep 12, 2024

Looking at https://docs.wxpython.org/ the layout of the home page looks a bit scrunched up compared to 4.2.1.

Docs_4 2 2

Docs_4 2 1

I get similar results in Firefox, Waterfox and Chromium browsers.

@ghost
Copy link
Author

ghost commented Sep 12, 2024

Also, in the Inheritance diagrams, some of the text in some of the boxes is cropped at the top, as shown in the bottom two boxes in the example below:

TopLevelWindow diagram

@swt2c
Copy link
Collaborator

swt2c commented Sep 12, 2024

Sigh, yeah I ran into lots of issues trying to build the documentation - mostly related to sphinx dependencies that have been updated but no longer work with old sphinx (2.2.0). The first issue you noted seems to be a bug in the generation.

I might just try updating to the latest sphinx (and unpin all its dependencies) and see how things look.

@ghost
Copy link
Author

ghost commented Sep 12, 2024

I see that there are non-dev tar.gz files of the demo (wxPython-demo-4.2.2.tar.gz), docs (wxPython-docs-4.2.2.tar.gz) and docset (wxPython-docset-4.2.2.tar.gz) in https://wxpython.org/Phoenix/snapshot-builds/

Should they be in a new folder: https://extras.wxpython.org/wxPython4/extras/4.2.2/ ?

@swt2c
Copy link
Collaborator

swt2c commented Sep 12, 2024

I see that there are non-dev tar.gz files of the demo (wxPython-demo-4.2.2.tar.gz), docs (wxPython-docs-4.2.2.tar.gz) and docset (wxPython-docset-4.2.2.tar.gz) in https://wxpython.org/Phoenix/snapshot-builds/

Should they be in a new folder: https://extras.wxpython.org/wxPython4/extras/4.2.2/ ?

Yes, I fixed that manually for now. I didn't automate that part yet. I also am not sure about those pdb files.

@ghost
Copy link
Author

ghost commented Sep 13, 2024

I noticed in line 95 of the index.html file in 4.2.2, there is an </aside> tag. When I replaced that tag with </div> (like there was in the 4.2.1 version), the formatting of the page appeared to be fixed.

It might be worth considering this as a temporary fix while you investigate the issue.

@swt2c
Copy link
Collaborator

swt2c commented Sep 13, 2024

Thanks! I made that change by hand. That definitely seems to have been the bug caused by .

Meanwhile, that bug doesn't exist when I build with the latest sphinx (but others do, sigh) so...

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 a pull request may close this issue.

1 participant