forked from py-pdf/fpdf2
/
mkdocs.yml
177 lines (171 loc) · 6.3 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
###
# Related docs: https://py-pdf.github.io/fpdf2/Development.html#documentation
#
# material theme docs: https://squidfunk.github.io/mkdocs-material/
###
site_name: fpdf2
site_url: https://py-pdf.github.io/fpdf2/
site_author: Lucas Cimon et al
site_description: fpdf2 - minimalist PDF creation library for Python
repo_url: https://github.com/py-pdf/fpdf2
repo_name: py-pdf/fpdf2
docs_dir: docs/
site_dir: public/
use_directory_urls: false
edit_uri: edit/master/docs
theme:
name: material
custom_dir: docs/overrides/
features:
- navigation.top
- toc.follow
palette:
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
markdown_extensions:
- admonition
- md_in_html
- pymdownx.critic
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.superfences
- toc:
permalink: true
plugins:
- search
- include-markdown
- mknotebooks
- minify:
minify_html: true
- redirects:
redirect_maps:
'CombineWithChartingLibs.md': 'Maths.md'
#- git-committers:
# repository: py-pdf/fpdf2
# branch: master
- with-pdf: # https://github.com/orzih/mkdocs-with-pdf
output_path: fpdf2-manual.pdf
cover_title: fpdf2 manual
cover_subtitle: A minimalist PDF creation library for Python
author: ' '
copyright: ' '
exclude_pages:
- 'Tutorial-de'
- 'Tutorial-es'
- 'Tutorial-fr'
- 'Tutorial-gr'
- 'Tutorial-it'
- 'Tutorial-km'
- 'Tutorial-pt'
- 'Tutorial-ru'
- 'Tutorial-hi'
- 'Tutorial-bn'
- 'Tutorial-he'
- 'Tutorial-zh'
- 'Tutorial-ja'
#cover: false
#back_cover: true
#custom_template_path: TEMPLATES PATH
#toc_title: TOC TITLE TEXT
#heading_shift: false
#toc_level: 3
#ordered_chapter_level: 2
#excludes_children:
# - 'release-notes/:upgrading'
#convert_iframe:
# - src: IFRAME SRC
# img: POSTER IMAGE URL
# text: ALTERNATE TEXT
#two_columns_level: 3
#render_js: true
#headless_chrome_path: headless-chromium
#enabled_if_env: ENABLE_PDF_EXPORT
#debug_html: true
#show_anchors: true
#verbose: true
nav:
- 'Project Home': 'index.md'
- 'Tutorial':
- 'Jupyter notebook': 'notebook.ipynb'
- 'Tutorial in English': 'Tutorial.md'
- 'Tutorial auf Deutsch': 'Tutorial-de.md'
- 'Tutorial en español': 'Tutorial-es.md'
- 'Tutorial en français': 'Tutorial-fr.md'
- 'Φροντιστήριο στα ελληνικά': 'Tutorial-gr.md'
- 'Tutorial in italiano': 'Tutorial-it.md'
- 'ភាសខ្មែរ': 'Tutorial-km.md'
- 'Tutorial em português': 'Tutorial-pt.md'
- 'Учебник на русском языке': 'Tutorial-ru.md'
- 'हिंदी में ट्यूटोरियल': 'Tutorial-hi.md'
- 'বাংলা': 'Tutorial-bn.md'
- 'מדריך בעברית': 'Tutorial-he.md'
- '简体中文教程': 'Tutorial-zh.md'
- '日本語チュートリアル': 'Tutorial-ja.md'
- 'Page Layout':
- 'Page Format and Orientation': 'PageFormatAndOrientation.md'
- 'Margins': 'Margins.md'
- 'Templates': 'Templates.md'
- 'Text Flow Regions':
- 'Basics': 'TextRegion.md'
- 'Text Columns': 'TextColumns.md'
- 'Tables': 'Tables.md'
- 'Text Content':
- 'Adding Text': 'Text.md'
- 'Line breaks': 'LineBreaks.md'
- 'Page breaks': 'PageBreaks.md'
- 'Text styling': 'TextStyling.md'
- 'Fonts and Unicode': 'Unicode.md'
- 'Text Shaping': 'TextShaping.md'
- 'Emojis, Symbols & Dingbats': 'EmojisSymbolsDingbats.md'
- 'HTML': 'HTML.md'
- 'Graphics Content':
- 'Images': 'Images.md'
- 'Shapes': 'Shapes.md'
- 'Transformations': 'Transformations.md'
- 'Transparency': 'Transparency.md'
- 'Barcodes': 'Barcodes.md'
- 'Drawing': 'Drawing.md'
- 'SVG': 'SVG.md'
- 'Charts & Graphs': 'Maths.md'
- 'PDF Features':
- 'Links': 'Links.md'
- 'Metadata': 'Metadata.md'
- 'Annotations': 'Annotations.md'
- 'Presentation Mode': 'Presentations.md'
- 'Document outline & table of contents': 'DocumentOutlineAndTableOfContents.md'
- 'Encryption': 'Encryption.md'
- 'Signing': 'Signing.md'
- 'File attachments': 'FileAttachments.md'
- 'Mixing other libs':
- 'Combine with borb': 'CombineWithBorb.md'
- 'Combine with livereload': 'CombineWithLivereload.md'
- 'Combine with pypdf': 'CombineWithPypdf.md'
- 'Combine with pdfrw': 'CombineWithPdfrw.md'
- 'Matplotlib, Pandas, Plotly, Pygal': 'CombineWithChartingLibs.md'
- 'Templating with Jinja': 'TemplatingWithJinja.md'
- 'Usage in web APIs': 'UsageInWebAPI.md'
- 'Database storage': 'DatabaseStorage.md'
- 'Development':
- 'Development guidelines': 'Development.md'
- 'Logging': 'Logging.md'
- 'API': 'https://py-pdf.github.io/fpdf2/fpdf/'
- 'History': 'History.md'
- 'FAQ': 'FAQ.md'
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/py-pdf/fpdf2
- icon: fontawesome/brands/python
link: https://pypi.org/project/fpdf2/