-
Notifications
You must be signed in to change notification settings - Fork 530
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d7225c3
commit b3fc187
Showing
2 changed files
with
74 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters