search

sqlalchemy / mako

Mako Templates for Python
https://www.makotemplates.org
MIT License
353 stars 60 forks source link

Documentation layout and examples. #369

Closed baluyotraf closed 1 year ago

baluyotraf commented 1 year ago

Hello!

I'm checking the link in the README.md which is https://docs.makotemplates.org/en/latest/usage.html. It looks like the API Reference side bar overflows.

image

Another thing is the code in the usage does not work for Python3.

image

There is already a discussion in https://github.com/sqlalchemy/mako/issues/234 about fixing it, basically changing StringIO to io

I can take a look at these issues, but I want to make sure that I didn't miss something.

zzzeek commented 1 year ago

these are going to be a little mroe difficult than usual to fix since you'd need to fix them over in Mako's sphinx extension at https://github.com/sqlalchemyorg/zzzeeksphinx/ . For some indication of what changed in general see https://github.com/sqlalchemy/alembic/commit/edd64ea2a322049a4a536c1a9ae8e498db73be23 and https://github.com/sphinx-doc/sphinx/issues/11000

baluyotraf commented 1 year ago

Okay, but the example should be fixed here right? Since it's part of the content.

Looking at the alembic solution, I assume you prefer to adjust the width?

zzzeek commented 1 year ago

oh there's an import in there too, sure that should be fixed as well, thanks!

zzzeek commented 1 year ago

for the CSS it's a small width adjust and also an "overflow:auto" so that it can scroll.

zzzeek commented 1 year ago

this is fixed