forked from Iran-Open-Data/HBSIR
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yaml
195 lines (181 loc) · 7.42 KB
/
mkdocs.yaml
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
site_name: HBSIR
site_url: https://iran-open-data.github.io/HBSIR/
repo_url: https://github.com/Iran-Open-Data/HBSIR
theme:
name: material
icon:
logo: fontawesome/solid/house-chimney
favicon: assets/images/house-chimney-solid.svg
palette:
# Palette toggle for light mode
- scheme: default
primary: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
primary: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
# - navigation.tracking
- navigation.tabs
# - navigation.tabs.sticky
- navigation.sections
# - navigation.expand
- navigation.indexes
# - header.autohide
- toc.follow
- navigation.top
- content.code.copy
- content.code.annotate
- content.tooltips
- content.tabs.link
nav:
- Home: README.md
- Usage:
- Installation Guide: usage/installation.md
- Tutorials:
- Rental Expences in Tehran: tutorials/tehran_rents.py
- API Reference:
- api/README.md
- Setup Functions:
- hbsir.setup: api/setup.md
- hbsir.setup_config: api/setup_config.md
- Data Loading Functions:
- hbsir.load_table: api/load_table.md
- hbsir.load_knowledge: api/load_knowledge.md
- Data Addition Functions:
- hbsir.add_attribute: api/add_attribute.md
- hbsir.add_classification: api/add_classification.md
- hbsir.add_weight: api/add_weight.md
- hbsir.calculate.add_quantile: api/calculate_add_quantile.md
- hbsir.calculate.add_decile: api/calculate_add_decile.md
- hbsir.calculate.add_percentile: api/calculate_add_percentile.md
- Analitical Functions:
- hbsir.calculate.weighted_average: api/calculate_weighted_average.md
- hbsir.calculate.average_table: api/calculate_average_table.md
- hbsir.calculate.quantile: api/calculate_quantile.md
- Data Reference:
- data/README.md
- Tables:
- tables/README.md
- Raw Tables:
# - tables/raw/README.md
- General Tables:
- Household Information: tables/raw/household_information.md
- Members Properties: tables/raw/members_properties.md
- House Specifications: tables/raw/house_specifications.md
- House Specifications (Old, Rural): tables/raw/old_rural_house_specifications.md
- House Specifications (Old, Urban): tables/raw/old_urban_house_specifications.md
- Expenditure Tables:
- Food: tables/raw/food.md
- Tobacco: tables/raw/tobacco.md
- Cloth: tables/raw/cloth.md
- Home: tables/raw/home.md
- Furniture: tables/raw/furniture.md
- Medical: tables/raw/medical.md
- Transportation: tables/raw/transportation.md
- Communication: tables/raw/communication.md
- Entertainment: tables/raw/entertainment.md
- Education: tables/raw/education.md
- Hotel: tables/raw/hotel.md
- Miscellaneous: tables/raw/miscellaneous.md
- Durable: tables/raw/durable.md
- Investment: tables/raw/investment.md
- Income Tables:
- Employment Income: tables/raw/employment_income.md
- Self Employed Income: tables/raw/self_employed_income.md
- Other Incomes: tables/raw/other_income.md
- Subsidy: tables/raw/subsidy.md
- Employment Income (Old, Rural, Public): tables/raw/old_rural_public_employment_income.md
- Employment Income (Old, Urban, Public): tables/raw/old_urban_public_employment_income.md
- Employment Income (Old, Rural, Private): tables/raw/old_rural_private_employment_income.md
- Employment Income (Old, Urban, Private): tables/raw/old_urban_private_employment_income.md
- Self Employed Income (Old, Agricultural): tables/raw/old_agricultural_self_employed_income.md
- Self Employed Income (Old, Non-Agricultural): tables/raw/old_non_agricultural_self_employed_income.md
- Other Income (Old): tables/raw/old_other_income.md
- Cleaned Tables:
# - tables/cleaned/README.md
- General Tables:
- Household Information: tables/cleaned/household_information.md
- Members Properties: tables/cleaned/members_properties.md
- House Specifications: tables/cleaned/house_specifications.md
- House Specifications (Old, Rural): tables/cleaned/old_rural_house_specifications.md
- House Specifications (Old, Urban): tables/cleaned/old_urban_house_specifications.md
- Expenditure Tables:
- Food: tables/cleaned/food.md
- Tobacco: tables/cleaned/tobacco.md
- Cloth: tables/cleaned/cloth.md
- Home: tables/cleaned/home.md
- Furniture: tables/cleaned/furniture.md
- Medical: tables/cleaned/medical.md
- Transportation: tables/cleaned/transportation.md
- Communication: tables/cleaned/communication.md
- Entertainment: tables/cleaned/entertainment.md
- Education: tables/cleaned/education.md
- Hotel: tables/cleaned/hotel.md
- Miscellaneous: tables/cleaned/miscellaneous.md
- Durable: tables/cleaned/durable.md
- Investment: tables/cleaned/investment.md
- Income Tables:
- Employment Income: tables/cleaned/employment_income.md
- Self Employed Income: tables/cleaned/self_employed_income.md
- Other Incomes: tables/cleaned/other_income.md
- Subsidy: tables/cleaned/subsidy.md
- Employment Income (Old, Rural, Public): tables/cleaned/old_rural_public_employment_income.md
- Employment Income (Old, Urban, Public): tables/cleaned/old_urban_public_employment_income.md
- Employment Income (Old, Rural, Private): tables/cleaned/old_rural_private_employment_income.md
- Employment Income (Old, Urban, Private): tables/cleaned/old_urban_private_employment_income.md
- Self Employed Income (Old, Agricultural): tables/cleaned/old_agricultural_self_employed_income.md
- Self Employed Income (Old, Non-Agricultural): tables/cleaned/old_non_agricultural_self_employed_income.md
- Other Income (Old): tables/cleaned/old_other_income.md
- Knowledge Base:
- knowledge/README.md
- Statistical Center of Iran:
- knowledge/sci_results.py
plugins:
- search
- autorefs
- mkdocs-jupyter:
execute: true
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [hbsir]
options:
docstring_style: numpy
show_source: false
markdown_extensions:
- abbr
- admonition
- attr_list
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- md_in_html
- pymdownx.inlinehilite
- def_list
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.arithmatex:
generic: true
- pymdownx.tabbed:
alternate_style: true
extra_javascript:
- javascripts/katex.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css