PyFake-API-Server/mkdocs.yml at master · Chisanan232/PyFake-API-Server · GitHub

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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
# Project information
site_name: PyFake-API-Server
site_url: https://chisanan232.github.io/pyfake-api-server/
site_author: Bryant Liu
site_description: >-
  Fake your API server, e.g., HTTP API server, by YAML configuration and set up an application in minutes

# Repository
repo_name: Chisanan232/PyFake-API-Server
repo_url: https://github.com/Chisanan232/PyFake-API-Server

# Copyright
copyright: Copyright &copy; 2023 - 2025 Bryant Liu

theme:
  name: material
  custom_dir: ./docs/_overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
#  favicon: assets/favicon.png
  icon:
    logo: logo

# Plugins
plugins:
  # Doc as Code
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx
            docstring_section_style: spacy
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            relative_crossrefs: true
  # Versioning documentation
  - mike:
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ''
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js
  # Documentation modification info - create & update time
  - git-revision-date-localized:
      type: timeago
#      custom_format: "%d. %B %Y"
      timezone: Asia/Taipei
#      locale: en
      fallback_to_build_date: false
      enable_creation_date: true
#      exclude:
#          - index.md
      enable_git_follow: true
      enabled: true
      strict: true
  # Documentation modification info - contributor
  - git-committers:
      repository: Chisanan232/PyFake-API-Server
      branch: master

# Additional configuration
extra:
  # Versioning documentation
  version:
    provider: mike
    default: stable
    alias: true
  # Documentation analytics
  analytics:
    provider: google
    property: G-G1YK8C9EE4
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback!
  # Social info
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Chisanan232
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/repository/docker/chisanan232/pyfake-api-server
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/fake-api-server/

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - PyFake-API-Server: index.md
  - Getting started:
    - Version requirements: getting-started/version-requirements.md
    - Installation: getting-started/installation.md
    - Configure your APIs: getting-started/configure-your-api.md
    - Set up web server: getting-started/setup-web-server.md
    - Command line usages:
      - subcommand:
        - command-line-usage/index.md
        - rest-server:
          - command-line-usage/rest-server/index.md
          - run: command-line-usage/rest-server/subcmd-run.md
          - get: command-line-usage/rest-server/subcmd-get.md
          - add: command-line-usage/rest-server/subcmd-add.md
          - check: command-line-usage/rest-server/subcmd-check.md
          - sample: command-line-usage/rest-server/subcmd-sample.md
          - pull: command-line-usage/rest-server/subcmd-pull.md
    - Action usages:
      - Run in GitHub Action:
        - action-usage/index.md
        - As RestFUL API: action-usage/rest-server.md
  - Configure references:
    - Basic info: configure-references/config-basic-info.md
    - Mocked API:
      - configure-references/mocked-apis/index.md
      - Template:
        - configure-references/mocked-apis/template/index.md
        - File setting:
          - configure-references/mocked-apis/template/file/index.md
          - Loading setting: configure-references/mocked-apis/template/file/load.md
          - Values setting: configure-references/mocked-apis/template/file/config_path_values.md
          - Apply setting: configure-references/mocked-apis/template/file/apply.md
        - Common configuration:
          - configure-references/mocked-apis/template/common_config/index.md
          - Format setting: configure-references/mocked-apis/template/common_config/format.md
      - Base:
        - configure-references/mocked-apis/base/index.md
      - API:
        - configure-references/mocked-apis/apis/index.md
        - URL: configure-references/mocked-apis/apis/url.md
        - HTTP:
          - configure-references/mocked-apis/apis/http/index.md
          - HTTP request: configure-references/mocked-apis/apis/http/request.md
          - HTTP response: configure-references/mocked-apis/apis/http/response.md
          - Common:
            - configure-references/mocked-apis/apis/http/common/index.md
            - Item element: configure-references/mocked-apis/apis/http/common/item_element.md
            - Value format: configure-references/mocked-apis/apis/http/common/value_format.md
            - Value format variable: configure-references/mocked-apis/apis/http/common/format_variable.md
  - Development:
    - development/index.md
    - How it works: development/how-it-works.md
    - Software technical details:
      - development/software-technical-details/index.md
      - About command line:
        - development/software-technical-details/command_line/index.md
        - Program entry point: development/software-technical-details/command_line/program_entry_point.md
        - Command line: development/software-technical-details/command_line/command_line.md
        - Processor: development/software-technical-details/command_line/command_line_processor.md
        - Subcommand line & options: development/software-technical-details/command_line/command_line_options.md
      - Utility functional:
        - development/software-technical-details/util_functional/index.md
        - Functional - file operation: development/software-technical-details/util_functional/file_operation.md
      - Rest-Server functional:
        - development/software-technical-details/rest-server_functional/index.md
        - Subcommand - *rest-server run*: development/software-technical-details/rest-server_functional/subcmd_run_core.md
    - Contributing :
      - development/contributing/index.md
      - Reporting a bug: development/contributing/reporting-a-bug.md
      - Requesting a feature or change: development/contributing/requesting-a-feature.md
      - Join in developing:
        - development/contributing/join_in_developing/index.md
        - Development workflow: development/contributing/join_in_developing/development_workflow.md
        - CI workflow: development/contributing/join_in_developing/ci_workflow.md
        - Developing: development/contributing/join_in_developing/developing.md
        - Testing: development/contributing/join_in_developing/testing.md
  - Release notes:
    - release_note/index.md
    - Version 0.X.X: release_note/version_0xx.md