Skip to content

Commit

Permalink
Add Development.md page
Browse files Browse the repository at this point in the history
  • Loading branch information
RomanKharin committed Apr 6, 2015
1 parent d7225c3 commit b3fc187
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
73 changes: 73 additions & 0 deletions docs/Development.md
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).

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down

0 comments on commit b3fc187

Please sign in to comment.