Skip to content

Commit b3fc187

Browse files
committed
Add Development.md page
1 parent d7225c3 commit b3fc187

2 files changed

Lines changed: 74 additions & 0 deletions

File tree

docs/Development.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Delopment #
2+
3+
[TOC]
4+
5+
## Inroduction ##
6+
7+
This page summary information about development PyPDF library.
8+
9+
This project started as python fork of [FPDF](http://fpdf.org/) PHP library.
10+
Later code for native reading TTF fonts was added. FPDF was not updated since
11+
2011. See also [TCPDF](http://www.tcpdf.org/) library.
12+
13+
Until 2015 code developed at [Google code](https://code.google.com/p/pyfpdf/).
14+
Now main repository at [Github](https://github.com/reingart/pyfpdf).
15+
16+
After commit to master repository code documentation will be uploaded to
17+
[Read the Docs](http://pyfpdf.rtfd.org/) site.
18+
19+
## Tips ##
20+
21+
### Code ###
22+
23+
Get master branch of code.
24+
```shell
25+
git clone https://github.com/reingart/pyfpdf.git
26+
```
27+
28+
You can also use issues and pull requests at github.
29+
30+
### Testing ###
31+
32+
Testing described in standalone page [Testing](Testing.md).
33+
34+
### Documentation ###
35+
36+
Documentation are in `docs` subfolder in
37+
[Markdown](http://daringfireball.net/projects/markdown/) format. To build use
38+
`mkdocs` utility, which directed by `mkdocs.yml`.
39+
40+
To build documentation use in repository root:
41+
42+
```
43+
mkdocs build
44+
```
45+
HTML files are generated in `html` subfolder.
46+
47+
To continiously rebuild docs on changing any `.md` files use:
48+
49+
```
50+
mkdocs serve
51+
```
52+
53+
Then open browser at `http://localhost:8000`. (Port and address can be changed).
54+
55+
**Note**: `mkdocs` internally chack internal links consistency. But somhow
56+
code like this:
57+
58+
```
59+
[Page Name][refe/PageName,md]
60+
```
61+
62+
Lead to nowhere and gives no error. To avoid this use:
63+
64+
```
65+
grep -r * -e ',md'
66+
```
67+
68+
And output should link to this page only.
69+
70+
## See also ##
71+
[Project Home](index.md), [Frequently asked questions](FAQ.md),
72+
[Unicode](Unicode.md), [Python 3](Python3.md), [Testing](Testing.md).
73+

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ pages:
1818
- [Unicode.md, "Unicode"]
1919
- [Web2Py.md, "Web2Py framework"]
2020
- [Testing.md, "Testing"]
21+
- [Development.md, "Development"]
2122
- ["reference/AcceptPageBreak.md", "Reference manual", "AcceptPageBreak"]
2223
- ["reference/AddFont.md", "Reference manual", "AddFont"]
2324
- ["reference/AddLink.md", "Reference manual", "AddLink"]

0 commit comments

Comments
 (0)