From b3fc187b6ec34e04f2d5853a4f8d1ca3ce1486fd Mon Sep 17 00:00:00 2001 From: Roman Kharin Date: Mon, 6 Apr 2015 13:03:00 +0300 Subject: [PATCH] Add Development.md page --- docs/Development.md | 73 +++++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 74 insertions(+) create mode 100644 docs/Development.md diff --git a/docs/Development.md b/docs/Development.md new file mode 100644 index 000000000..5a9e8178b --- /dev/null +++ b/docs/Development.md @@ -0,0 +1,73 @@ +# Delopment # + +[TOC] + +## Inroduction ## + +This page summary information about development PyPDF library. + +This project started as python fork of [FPDF](http://fpdf.org/) PHP library. +Later code for native reading TTF fonts was added. FPDF was not updated since +2011. See also [TCPDF](http://www.tcpdf.org/) library. + +Until 2015 code developed at [Google code](https://code.google.com/p/pyfpdf/). +Now main repository at [Github](https://github.com/reingart/pyfpdf). + +After commit to master repository code documentation will be uploaded to +[Read the Docs](http://pyfpdf.rtfd.org/) site. + +## Tips ## + +### Code ### + +Get master branch of code. +```shell +git clone https://github.com/reingart/pyfpdf.git +``` + +You can also use issues and pull requests at github. + +### Testing ### + +Testing described in standalone page [Testing](Testing.md). + +### Documentation ### + +Documentation are in `docs` subfolder in +[Markdown](http://daringfireball.net/projects/markdown/) format. To build use +`mkdocs` utility, which directed by `mkdocs.yml`. + +To build documentation use in repository root: + +``` +mkdocs build +``` +HTML files are generated in `html` subfolder. + +To continiously rebuild docs on changing any `.md` files use: + +``` +mkdocs serve +``` + +Then open browser at `http://localhost:8000`. (Port and address can be changed). + +**Note**: `mkdocs` internally chack internal links consistency. But somhow +code like this: + +``` +[Page Name][refe/PageName,md] +``` + +Lead to nowhere and gives no error. To avoid this use: + +``` +grep -r * -e ',md' +``` + +And output should link to this page only. + +## See also ## +[Project Home](index.md), [Frequently asked questions](FAQ.md), +[Unicode](Unicode.md), [Python 3](Python3.md), [Testing](Testing.md). + diff --git a/mkdocs.yml b/mkdocs.yml index e96946dd6..3a4427445 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,6 +18,7 @@ pages: - [Unicode.md, "Unicode"] - [Web2Py.md, "Web2Py framework"] - [Testing.md, "Testing"] +- [Development.md, "Development"] - ["reference/AcceptPageBreak.md", "Reference manual", "AcceptPageBreak"] - ["reference/AddFont.md", "Reference manual", "AddFont"] - ["reference/AddLink.md", "Reference manual", "AddLink"]