xref: /aosp_15_r20/external/kotlinpoet/mkdocs.yml (revision 3c321d951dd070fb96f8ba59e952ffc3131379a0)
1*3c321d95SSadaf Ebrahimi# pip install mkdocs mkdocs-material
2*3c321d95SSadaf Ebrahimi# mkdocs serve
3*3c321d95SSadaf Ebrahimi# mkdocs gh-deploy
4*3c321d95SSadaf Ebrahimi
5*3c321d95SSadaf Ebrahimisite_name: KotlinPoet
6*3c321d95SSadaf Ebrahimirepo_name: KotlinPoet
7*3c321d95SSadaf Ebrahimirepo_url: https://github.com/square/kotlinpoet
8*3c321d95SSadaf Ebrahimisite_description: "A Kotlin API for generating .kt source files"
9*3c321d95SSadaf Ebrahimisite_author: Square, Inc.
10*3c321d95SSadaf Ebrahimiremote_branch: gh-pages
11*3c321d95SSadaf Ebrahimi
12*3c321d95SSadaf Ebrahimicopyright: 'Copyright © 2015 Square, Inc.'
13*3c321d95SSadaf Ebrahimi
14*3c321d95SSadaf Ebrahimitheme:
15*3c321d95SSadaf Ebrahimi  name: 'material'
16*3c321d95SSadaf Ebrahimi  logo: 'images/icon-square.png'
17*3c321d95SSadaf Ebrahimi  favicon: 'images/icon-square.png'
18*3c321d95SSadaf Ebrahimi  palette:
19*3c321d95SSadaf Ebrahimi    - media: '(prefers-color-scheme: light)'
20*3c321d95SSadaf Ebrahimi      scheme: default
21*3c321d95SSadaf Ebrahimi      primary: 'cyan'
22*3c321d95SSadaf Ebrahimi      accent: 'deep-purple'
23*3c321d95SSadaf Ebrahimi      toggle:
24*3c321d95SSadaf Ebrahimi        icon: material/weather-night
25*3c321d95SSadaf Ebrahimi        name: Switch to dark mode
26*3c321d95SSadaf Ebrahimi    - media: '(prefers-color-scheme: dark)'
27*3c321d95SSadaf Ebrahimi      scheme: slate
28*3c321d95SSadaf Ebrahimi      primary: 'black'
29*3c321d95SSadaf Ebrahimi      accent: 'blue-grey'
30*3c321d95SSadaf Ebrahimi      toggle:
31*3c321d95SSadaf Ebrahimi        icon: material/weather-sunny
32*3c321d95SSadaf Ebrahimi        name: Switch to light mode
33*3c321d95SSadaf Ebrahimi
34*3c321d95SSadaf Ebrahimiextra_css:
35*3c321d95SSadaf Ebrahimi  - 'css/app.css'
36*3c321d95SSadaf Ebrahimi
37*3c321d95SSadaf Ebrahimimarkdown_extensions:
38*3c321d95SSadaf Ebrahimi  - smarty
39*3c321d95SSadaf Ebrahimi  - codehilite:
40*3c321d95SSadaf Ebrahimi      guess_lang: false
41*3c321d95SSadaf Ebrahimi  - footnotes
42*3c321d95SSadaf Ebrahimi  - meta
43*3c321d95SSadaf Ebrahimi  - toc:
44*3c321d95SSadaf Ebrahimi      permalink: true
45*3c321d95SSadaf Ebrahimi  - pymdownx.betterem:
46*3c321d95SSadaf Ebrahimi      smart_enable: all
47*3c321d95SSadaf Ebrahimi  - pymdownx.caret
48*3c321d95SSadaf Ebrahimi  - pymdownx.inlinehilite
49*3c321d95SSadaf Ebrahimi  - pymdownx.magiclink
50*3c321d95SSadaf Ebrahimi  - pymdownx.smartsymbols
51*3c321d95SSadaf Ebrahimi  - pymdownx.superfences
52*3c321d95SSadaf Ebrahimi  - pymdownx.emoji
53*3c321d95SSadaf Ebrahimi  - tables
54*3c321d95SSadaf Ebrahimi  - admonition
55*3c321d95SSadaf Ebrahimi
56*3c321d95SSadaf Ebrahiminav:
57*3c321d95SSadaf Ebrahimi  - 'Overview':
58*3c321d95SSadaf Ebrahimi    - 'Code & Control Flow': code-control-flow.md
59*3c321d95SSadaf Ebrahimi    - 'Format Specifiers':
60*3c321d95SSadaf Ebrahimi      - '%S for Strings': s-for-strings.md
61*3c321d95SSadaf Ebrahimi      - '%P for String Templates': p-for-string-templates.md
62*3c321d95SSadaf Ebrahimi      - '%T for Types': t-for-types.md
63*3c321d95SSadaf Ebrahimi      - '%M for Members': m-for-members.md
64*3c321d95SSadaf Ebrahimi      - '%N for Names': n-for-names.md
65*3c321d95SSadaf Ebrahimi      - '%L for Literals': l-for-literals.md
66*3c321d95SSadaf Ebrahimi      - 'Code Block Format Strings': code-block-format-strings.md
67*3c321d95SSadaf Ebrahimi    - 'Functions': functions.md
68*3c321d95SSadaf Ebrahimi    - 'Constructors': constructors.md
69*3c321d95SSadaf Ebrahimi    - 'Parameters': parameters.md
70*3c321d95SSadaf Ebrahimi    - 'Properties': properties.md
71*3c321d95SSadaf Ebrahimi    - 'Interfaces': interfaces.md
72*3c321d95SSadaf Ebrahimi    - 'Objects': objects.md
73*3c321d95SSadaf Ebrahimi    - 'Enums': enums.md
74*3c321d95SSadaf Ebrahimi    - 'Anonymous Inner Classes': anonymous-inner-classes.md
75*3c321d95SSadaf Ebrahimi    - 'Annotations': annotations.md
76*3c321d95SSadaf Ebrahimi    - 'Type Aliases': type-aliases.md
77*3c321d95SSadaf Ebrahimi    - 'Callable References': callable-references.md
78*3c321d95SSadaf Ebrahimi    - 'kotlin-reflect': kotlin-reflect.md
79*3c321d95SSadaf Ebrahimi  - 'Interop - JavaPoet': interop-javapoet.md
80*3c321d95SSadaf Ebrahimi  - 'Interop - kotlin-metadata': interop-kotlin-metadata.md
81*3c321d95SSadaf Ebrahimi  - 'Interop - KSP': interop-ksp.md
82*3c321d95SSadaf Ebrahimi  - 'API':
83*3c321d95SSadaf Ebrahimi    - 'kotlinpoet': 1.x/kotlinpoet/index.html
84*3c321d95SSadaf Ebrahimi    - 'interop-javapoet': 1.x/interop-javapoet/index.html
85*3c321d95SSadaf Ebrahimi    - 'interop-kotlinx-metadata': 1.x/interop-kotlinx-metadata/index.html
86*3c321d95SSadaf Ebrahimi    - 'interop-ksp': 1.x/interop-ksp/index.html
87*3c321d95SSadaf Ebrahimi  - 'Stack Overflow ⏏': https://stackoverflow.com/questions/tagged/kotlinpoet?sort=active
88*3c321d95SSadaf Ebrahimi  - 'Change Log': changelog.md
89*3c321d95SSadaf Ebrahimi  - 'Contributing': contributing.md
90