The flask-docs from pallets

flask-docs's Introduction

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.

flask-docs's People

Contributors

Stargazers

Watchers

flask-docs's Issues

Bot is waiting for input while building tex

Ran the builder manually to figure out why nothing was building. Builder is sitting waiting for input, which it will never get. Had to enter Ctrl-D at each of the ? prompts.

...
Package hyperref Message: Driver (autodetected): hpdftex.

(/usr/share/texlive/texmf-dist/tex/latex/hyperref/hpdftex.def
(/usr/share/texlive/texmf-dist/tex/latex/oberdiek/rerunfilecheck.sty))
(/usr/share/texlive/texmf-dist/tex/latex/oberdiek/hypcap.sty) (./jinjastyle.sty
 (/usr/share/texlive/texmf-dist/tex/latex/inconsolata/inconsolata.sty))
Writing index file Jinja2.idx
(./Jinja2.aux) (/usr/share/texlive/texmf-dist/tex/latex/base/ts1cmr.fd)
(/usr/share/texlive/texmf-dist/tex/latex/psnfss/t1ppl.fd)
(/usr/share/texlive/texmf-dist/tex/context/base/supp-pdf.mkii
[Loading MPS to PDF converter (version 2006.09.02).]
) (/usr/share/texlive/texmf-dist/tex/latex/oberdiek/epstopdf-base.sty
(/usr/share/texlive/texmf-dist/tex/latex/oberdiek/grfext.sty)
(/usr/share/texlive/texmf-dist/tex/latex/latexconfig/epstopdf-sys.cfg))
*geometry* driver: auto-detecting
*geometry* detected driver: pdftex
(/usr/share/texlive/texmf-dist/tex/latex/hyperref/nameref.sty
(/usr/share/texlive/texmf-dist/tex/generic/oberdiek/gettitlestring.sty))
(./Jinja2.out) (./Jinja2.out)
! Undefined control sequence.
\maketitle ...tnoterule \relax \ifsphinxpdfoutput 
                                                  \begingroup \def \\{, } \p...
l.55 \maketitle
               
?

Recommend Projects