search

Pylons / pyramid_handlers

Pyramid "handlers" emulate Pylons 1 "controllers"
Other
8 stars 9 forks source link

Code-formatting in docs overlaps with other lines, making them hard to read #8

Open maxalbert opened 6 years ago

maxalbert commented 6 years ago

The pyramids_handlers documentation uses a formatting style which displays code using a gray background and having two gray horizontal lines above and below the code-formatted text.

These horizontal lines overlap with preceding and following lines of text, which makes it difficult to read the documentation (see screenshot below - the problem is visible in the table of contents and the first couple of lines in the "Overview" and "Setup" sections).

It would be good to change the styling to avoid this issue.

Tested using Chrome 61.0.3163.100 and Firefox 57.0b5.

pyramid_handlers_docs_screenshot
stevepiercy commented 6 years ago

This package was never updated to use pylons_sphinx_themes and still uses git submodules, so it has wacky styles. I would accept a pull request that follows the instructions for that package.

As a side note, please read the article Outgrowing Pyramid Handlers.