forked from hotosm/fmtm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
98 lines (91 loc) · 2.67 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
site_name: FMTM
site_description: Coordinated field mapping for Open Mapping campaigns.
# strict: true
site_url: "https://docs.fmtm.dev/"
repo_name: "hotosm/fmtm"
repo_url: "https://github.com/hotosm/fmtm/"
edit_uri: "edit/main/docs/"
extra:
social:
- icon: "fontawesome/brands/github"
link: "https://github.com/hotosm/"
- icon: "fontawesome/brands/twitter"
link: "https://twitter.com/hotosm"
- icon: "fontawesome/solid/globe"
link: "https://www.hotosm.org"
copyright: Copyright © 2010 HOTOSM
generator: false
theme:
name: material
palette:
primary: custom
language: en
favicon: images/favicon.png
logo: images/hot_logo.png
extra_css:
- css/extra.css
markdown_extensions:
- tables
- toc:
permalink: true
title: Page contents
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight
- pymdownx.extra
- pymdownx.emoji:
- pymdownx.tabbed:
alternate_style: true
- mdx_truly_sane_lists
plugins:
- search
- git-revision-date-localized
- exclude:
glob:
- plugins/*
- __pycache__/*
- mkdocstrings:
handlers:
python:
paths: [.]
options:
members_order: source
separate_signature: true
filters: ["!^_"]
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
nav:
- Home: index.md
- Get Started:
- About: About.md
- Installation: INSTALL.md
- Contribution Guidelines: CONTRIBUTING.md
- Code of Conduct: https://docs.hotosm.org/code-of-conduct
- FAQ: FAQ.md
- User Manuals:
- User Types: user-breakdown.md
- Project Managers: User-Manual-For-Project-Managers.md
- Dev:
- Setup: dev/Setup.md
- Backend: dev/Backend.md
- Frontend: dev/Frontend.md
- Production Deployment: dev/Production.md
- Release Cycle: dev/Release-Cycle.md
- Database Tips: dev/Database-Tips.md
- Troubleshooting: dev/Troubleshooting.md
- Pre-Commit: https://docs.hotosm.org/dev-guide/pre-commit/
- Versioning: https://docs.hotosm.org/dev-guide/version-control/#creating-releases
- Class Hierarchy: apidocs/html/inherits.html
- Code Coverage: coverage.html
- Utilities:
- XLSForm Converter: https://getodk.org/xlsform/
- QRCode Converter: qrcode-util.md
- Helpers: https://api.stage.fmtm.hotosm.org/docs#/helper
- Example XLSForms: example-xlsforms/README.md
- Roadmap:
- Users: user-roadmap.md
- Developers: https://roadmap.fmtm.dev
- Timeline: timeline.md
- API Docs: https://hotosm.github.io/swagger/?url=https://docs.fmtm.dev/openapi.json