Skip to content

Commit

Permalink
cleadup config
Browse files Browse the repository at this point in the history
  • Loading branch information
saxix committed Sep 6, 2024
1 parent 3c29664 commit 26f8843
Show file tree
Hide file tree
Showing 10 changed files with 66 additions and 78 deletions.
3 changes: 2 additions & 1 deletion docs/components/.pages
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
nav:
- index.md
- hope.md
- hde.md
- Payment Gateway: components/pg/
- Payment Gateway: pg
- aurora.md
- kobo.md
- reporting.md
Expand Down
5 changes: 5 additions & 0 deletions docs/components/hope.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# HOPE (core)

- [User Manual](../guide-user/index.md)
- [Development Manual](../guide-dev/index.md)
- [Administration Manual](../guide-adm/index.md)
14 changes: 0 additions & 14 deletions docs/components/hope/stack.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/components/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Hope (core)
title: Ecosystem
---

# Ecosystem components
Expand Down
3 changes: 3 additions & 0 deletions docs/components/pg/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
nav:
- index.md
- wu.md
4 changes: 0 additions & 4 deletions docs/components/pg/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
title: Payment Gateway
---

# Payment Gateway


Expand Down
1 change: 0 additions & 1 deletion docs/guide-adm/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ tags:

# Dependencies

- Python 3.12
- Postgres 15
- Redis
- ElasticSearch
Empty file added docs/guide-adm/index.md
Empty file.
2 changes: 1 addition & 1 deletion docs/guide-user/people.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ c) Import data through API

#### Beneficiary Registration with KOBO

[KoBo](Kobo) is a digital data collection tool that allows creation of customization of registration forms and easy collation of data for reporting and programmatic use. It consists of two components:
KoBo is a digital data collection tool that allows creation of customization of registration forms and easy collation of data for reporting and programmatic use. It consists of two components:
1. KoBo Toolbox which is a web application
2. KoBo Collect which is mobile application (for Android)

Expand Down
110 changes: 54 additions & 56 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ site_description: "Documentation"
site_dir: ./~build/docs
site_name: "Documentation"
site_url: https://unicef.github.io/hope-documentation/
strict: true
#strict: true
extra_css:
- _theme/css/style.css
extra_javascript:
Expand All @@ -25,30 +25,30 @@ markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- md_in_html
- mkdocs-click
# - def_list
# - md_in_html
# - mkdocs-click
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.details
# - pymdownx.details
- pymdownx.snippets:
base_path: 'docs'
check_paths: true
url_download: true
auto_append:
- _includes/abbreviations.md
- pymdownx.highlight:
use_pygments: true
- pymdownx.tabbed:
alternate_style: true
- smarty
- tables
- toc:
permalink: #
baselevel: 1
# auto_append:
# - _includes/abbreviations.md
# - pymdownx.highlight:
# use_pygments: true
# - pymdownx.tabbed:
# alternate_style: true
# - smarty
# - tables
# - toc:
# permalink: #
# baselevel: 1


extra:
Expand Down Expand Up @@ -94,24 +94,24 @@ theme:
features:
- content.action.edit
- content.code.copy
- content.tooltips
- header.autohide
- navigation.footer
# - content.tooltips
# - header.autohide
# - navigation.footer
- navigation.indexes
- navigation.tabs
- navigation.sections
- toc.integrate
# - navigation.sections
# - toc.integrate
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.progress
# - navigation.instant.prefetch
# - navigation.instant.progress

plugins:
- alias
- gen-files:
scripts:
# - docs/_scripts/build_glossary.py
- docs/_scripts/get_settings.py
- autorefs
# - alias
# - gen-files:
# scripts:
## - docs/_scripts/build_glossary.py
# - docs/_scripts/get_settings.py
# - autorefs
- awesome-pages:
filename: .pages
collapse_single_pages: true
Expand All @@ -125,40 +125,38 @@ plugins:
list_definitions: true
list_references: true
tooltip: heading
- ezlinks
# - ezlinks
- link-marker
- mkdocstrings
- include-markdown:
encoding: ascii
preserve_includer_indent: false
dedent: false
trailing_newlines: true
comments: false
rewrite_relative_urls: true
heading_offset: 0
# start: <!--start-->
# end: <!--end-->
recursive: true
# - mkdocstrings
# - include-markdown:
# encoding: ascii
# preserve_includer_indent: false
# dedent: false
# trailing_newlines: true
# comments: false
# rewrite_relative_urls: true
# heading_offset: 0
# recursive: true
- privacy
- search
- social:
cards_dir: assets/images/social
cards_layout_options:
font_family: Noto Sans SC
# - autolinks
- blog:
blog_dir: howto
blog_toc: true
post_dir: "{blog}/posts"
post_date_format: ""
post_url_max_categories: 1
# post_excerpt: optional
post_readtime: false
archive: false
categories: false
authors: false
pagination: false
draft: false
## - autolinks
# - blog:
# blog_dir: howto
# blog_toc: true
# post_dir: "{blog}/posts"
# post_date_format: ""
# post_url_max_categories: 1
## post_excerpt: optional
# post_readtime: false
# archive: false
# categories: false
# authors: false
# pagination: false
# draft: false
- tags:
tags_file: tags.md

Expand Down

0 comments on commit 26f8843

Please sign in to comment.