Giter VIP home page Giter VIP logo

zzzeeksphinx's Introduction

SQLAlchemy Website

This site uses zeekofile to build a static site, which can also be served locally using zeekofile.

Building and Testing:

#!/bin/bash

virtualenv .venv
source .venv/bin/activate
pip install git+https://github.com/sqlalchemyorg/zeekofile
git clone https://github.com/sqlalchemyorg/sqlalchemyorg
cd sqlalchemyorg/
pip install -r requirements.txt
zeekofile --serve

Then view:

http://127.0.0.1:8080

zzzeeksphinx's People

Contributors

aidos avatar caselit avatar kataev avatar thomasgoirand avatar zzzeek avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

zzzeeksphinx's Issues

Wrong HTML meta tag

In Mako-1.3.2 release tarball, the HTML docs contains a wrong meta tag:

<meta name="viewport" content="width=device-width, initial-scale=1">

(lacking a / before >).

improve documentation legibility

This is only an idea, and eventually it could be improved a lot, but most of the issues with the documentation legibility I think are those

  • color contrast is not sufficient to distinguish links from text
  • there is an effect of "box in a box in a box" further accentuated by box-shadows and borders that distracts instead of helping separating element types
  • various shadows, like snippet boxes have borders that accentuate that boxed content effect
  • the sidebar has a color that distracts from the main content
  • there are issues with the header that repeats the same informations in multiple places

this is an experiment for this page https://docs.sqlalchemy.org/en/20/orm/extensions/asyncio.html that addresses those issues and I would like some feedback for this direction before proposing a simple patch

immagine

Support for reproducible 'Documentation last generated' output

Hi folks - I was wondering whether a pull request to make the 'Documentation last generated' line reproducible (deterministic) on platforms that follow the relevant Reproducible Builds standard would be acceptable?

In supporting environments, that'd allow packages of sqlalchemy-plus-documentation to generate in a deterministic way, providing a bunch of benefits and reassurances for downstream consumers.

(a patch to do so has been suggested for downstream Debian; I'm offering to pick that up and provide it as a pull request here)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.