GitHub - pallets/flask-docs: A tool to build the Flask documentation in different versions.

This repository has been archived by the owner on Jul 11, 2019. It is now read-only.

pallets / flask-docs Public archive

Notifications You must be signed in to change notification settings
Fork 12
Star 36

A tool to build the Flask documentation in different versions.

View license

36 stars 12 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 89 Commits
configs		configs
themes		themes
.gitignore		.gitignore
LICENSE		LICENSE
README		README
docbuilder.py		docbuilder.py
nginx.conf		nginx.conf
setup.py		setup.py

Repository files navigation

Flask Documentation
===================

No longer used. The docs are now built and hosted with Read the Docs.
The Sphinx themes are at https://github.com/pallets/pallets-sphinx-themes.

This repository contains sphinx styles for Flask and Flask related
projects and a wrapper script to build the online documentation.

How to build the docs (for instance Flask):

  $ pip install --editable .
  $ flask-docbuilder build --config configs/flask.json

Note that the master branch is built by the pocoo build server.
Changes here might break the build so please be careful.

How it works in general:

* themes are shared and live in the `themes` folder.
* configs about how the per-project docs are structured live in
  the `configs` folder.
* the build server runs `flask-docbuilder build-all` to generate
  all documentation and stores it on the pocoo server.