docs/mkdocs.yml at main · linea-it/docs · 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
258
259
260
261
262
263
264
nav:
  - Início: pt/index.md
  - Primeiros Passos:
      - Registro de Usuários: pt/primeiros_passos.md
      - Registro para membros do LSST: pt/registro_user_lsst.md
  - Plataformas Científicas:
      - Plataformas Científicas: pt/sci-platforms/index.md #intro e LSP landing page
      - JupyterHub: pt/sci-platforms/jupyter.md
      - Ondemand: pt/sci-platforms/ondemand.md
      - User Query: pt/sci-platforms/user_query.md
      - TAP Service: sci-platforms/user_query.html#tap-service # pt/ removido para evitar conflito de links
      - Sky Viewer: pt/sci-platforms/sky_viewer.md
      - Target Viewer: pt/sci-platforms/target_viewer.md
      - DES Science Server: pt/sci-platforms/sci_server.md
      - Occultation Predictions Database: pt/sci-platforms/linea-occulation-prediction-database.md
      - SDSS Sky Sever: pt/sci-platforms/sdss_sky_server.md
      - LSST Photo-z Server: pt/sci-platforms/pz_server.md
      - DES Science Portal: pt/sci-platforms/des.md
      - Solar System Portal: pt/sci-platforms/solar-system-portal.md
      - MaNGA Portal: pt/sci-platforms/manga.md
  - Processamento (HPC):
      - Processamento (HPC): pt/processamento/index.md
      - Cluster Apollo:
            - Cluster Apollo: pt/processamento/apollo/index.md
            - Como utilizar: pt/processamento/uso/howtouse-HPC.md
            - Container (Apptainer): processamento/uso/apptainer-uso.md
            - EUPS: processamento/uso/howtouse-HPC.html#eups-gerenciador-de-pacotes
            - Conda: processamento/uso/howtouse-HPC.html#conda-no-ambiente-hpc
            - Jupyterlab (Ondemand): processamento/uso/openondemand.html#jupyterlab
            - Ondemand: pt/processamento/uso/openondemand.md
            - Slurm: processamento/apollo/index.html#slurm
            - Job Script (exemplos): pt/processamento/uso/templates-jobs.md
  - Armazenamento:
      - Armazenamento: pt/armazenamento/index.md
 #     - Lustre: pt/armazenamento/lustre.md
  - Dados:
      - Dados: pt/data/index.md
      #- DES: pt/data/des.md
      #- LSST: pt/data/lsst.md
  - Políticas: pt/politicas.md
  #- Photoz Server: 'pt/photozserver.md'
  #- Armazenamento: 'pt/armazenamento.md'
  #- Monitoramento: 'pt/monitoramento.md'
  - Cursos e Tutoriais: 'pt/cursos.md'
  - Glossário: 'pt/glossario.md'
  - Suporte: 'pt/suporte.md'
  #- FAQ: 'pt/faq.md'
  #- Mkdocs Exemplos: 'pt/exemplos/exemplos.md' #provisorio


# Site information
#docs_dir: docs
site_name:  Documentação para Usuários
site_author: LIneA team
site_url: "https://docs.linea.org.br"
repo_name: linea-it/docs
repo_url: https://github.com/linea-it/docs
edit_uri: 'edit/main/docs'
use_directory_urls: false
copyright: 'Copyright &copy; 2006 - 2024 LIneA'
# cosmo, material-components, cerulean, journal, slate, readthedocs, readable, spacelab, united, bootstrap, simplex, flatly, yeti, psinder, amelia, cyborg, unidata, mkdocs


# Configuration
theme:
  name: material
  custom_dir: linea-theme
  logo: 'images/linea.png'
  favicon: 'images/linea_favicon.png'
  font:
    text: Roboto, Arial
  features:
    - navigation.indexes


  palette:
      # Palette toggle for light mode
  - scheme: default
    toggle:
      icon: material/lightbulb
      name: Switch to dark mode
    primary: 'blue'
    accent: 'deep orange'

  # Palette toggle for dark mode
  - scheme: slate
    toggle:
      icon: material/lightbulb-outline
      name: Switch to light mode
    primary: 'grey'
    accent: 'deep orange'

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

extra:
  social:
    - icon: material/home-circle
      link: https://www.linea.org.br
    - icon: fontawesome/brands/github
      link: https://github.com/linea-it
    - icon: material/twitter
      link: https://twitter.com/linea_org
    - icon: material/instagram
      link: https://instagram.com/linea_org
    - icon: material/facebook
      link: https://facebook.com/linea.org
    - icon: material/youtube
      link: https://youtube.com/@linea_org

# Extensions
markdown_extensions:
  - attr_list
  - meta
  - footnotes
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols:
      fractions: false
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets

plugins:
    - i18n:
        docs_structure: folder
        languages:
          - locale: pt
            default: true
            name: Português
            build: true
          - locale: en
            name: English
            build: true
            site_name: "User Documentation"
            nav:
              - Home: en/index.md
              - Getting Started:
                  - User Registration: en/primeiros_passos.md
                  - LSST Member Registration: en/lsst_member_registration.md
              - Scientific Platforms:
                  - Scientific Platforms: en/sci-platforms/index.md #intro and LSP landing page
                  - JupyterHub: en/sci-platforms/jupyter.md
                  - Ondemand: en/sci-platforms/ondemand.md
                  - User Query: en/sci-platforms/user_query.md
                  - TAP Service: en/sci-platforms/user_query.html#tap-service
                  - Sky Viewer: en/sci-platforms/sky_viewer.md
                  - Target Viewer: en/sci-platforms/target_viewer.md
                  - DES Science Server: en/sci-platforms/sci_server.md
                  - Occultation Predictions Database: en/sci-platforms/linea-occulation-prediction-database.md
                  - SDSS Sky Server: en/sci-platforms/sdss_sky_server.md
                  - LSST Photo-z Server: en/sci-platforms/pz_server.md
                  - DES Science Portal: en/sci-platforms/des.md
                  - Solar System Portal: en/sci-platforms/solar-system-portal.md
                  - MaNGA Portal: en/sci-platforms/manga.md
              - Processing (HPC):
                  - Processing (HPC): en/processamento/index.md
                  - Apollo Cluster:
                        - Apollo Cluster: en/processamento/apollo/index.md
                        - How to Use: en/processamento/uso/howtouse-HPC.md
                        - Apptainer: en/processamento/uso/apptainer-uso.md
                        - EUPS: en/processamento/uso/howtouse-HPC.html#eups-package-manager
                        - Conda: en/processamento/uso/howtouse-HPC.html#conda-in-the-hpc-environment
                        - JupyterLab (OnDemand): en/processamento/uso/openondemand.html#jupyterlab
                        - Ondemand: en/processamento/uso/openondemand.md
                        - Slurm: en/processamento/apollo/index.html#slurm
                        - Job Script (examples): en/processamento/uso/templates-jobs.md
              - Storage:
                  - Storage: en/armazenamento/index.md
            #     - Lustre: en/armazenamento/lustre.md
              - Data:
                  - Data: en/data/index.md
                  #- DES: en/data/des.md
                  #- LSST: en/data/lsst.md
              - Policies: en/politicas.md
              #- Photoz Server: 'en/photozserver.md'
              #- Storage: 'en/armazenamento.md'
              #- Monitoring: 'en/monitoramento.md'
              - Courses and Tutorials: en/cursos.md
              - Glossary: en/glossario.md
              - Support: en/suporte.md
              #- FAQ: en/faq.md
              #- Mkdocs Examples: en/exemplos/exemplos.md #temporary
          - locale: es
            name: Español
            build: true
            site_name: "Documentación para Usuarios"
            nav:
              - Inicio: es/index.md
              - Primeros Pasos:
                - Registro de usuario: es/primeiros_passos.md
                - Registro de miembros de LSST: es/registro_user_lsst.md
              - Plataformas Científicas:
                - Plataformas Científicas: es/sci-platforms/index.md #intro and LSP landing page
                - JupyterHub: es/sci-platforms/jupyter.md
                - Ondemand: es/sci-platforms/ondemand.md
                - User Query: es/sci-platforms/user_query.md
                - TAP Service: es/sci-platforms/user_query.html#tap-service
                - Sky Viewer: es/sci-platforms/sky_viewer.md
                - Target Viewer: es/sci-platforms/target_viewer.md
                - DES Science Server: es/sci-platforms/sci_server.md
                - Occultation Predictions Database: es/sci-platforms/linea-occulation-prediction-database.md
                - SDSS Sky Sever: es/sci-platforms/sdss_sky_server.md
                - LSST Photo-z Server: es/sci-platforms/pz_server.md
                - DES Science Portal: es/sci-platforms/des.md
                - Solar System Portal: es/sci-platforms/solar-system-portal.md
                - MaNGA Portal: es/sci-platforms/manga.md
              - Procesamiento (HPC):
                  - Procesamiento (HPC): es/processamento/index.md
                  - Cluster Apollo:
                        - Cluster Apollo: es/processamento/apollo/index.md
                        - Cómo Utilizar: es/processamento/uso/howtouse-HPC.md
                        - Apptainer: es/processamento/uso/apptainer-uso.md
                        - EUPS: es/processamento/uso/howtouse-HPC.html#eups-gestor-de-paquetes
                        - Conda: es/processamento/uso/howtouse-HPC.html#conda-en-el-entorno-hpc
                        - JupyterLab (OnDemand): es/processamento/uso/openondemand.html#jupyterlab
                        - Ondemand: es/processamento/uso/openondemand.md
                        - Slurm: es/processamento/apollo/index.html#slurm
                        - Scripts de Trabajo (ejemplos): es/processamento/uso/templates-jobs.md
              - Almacenamiento:
                  - Almacenamiento: es/armazenamento/index.md
            #     - Lustre: es/armazenamento/lustre.md
              - Datos:
                  - Datos: es/data/index.md
                  #- DES: es/data/des.md
                  #- LSST: es/data/lsst.md
              - Políticas: es/politicas.md
              #- Servidor Photoz: 'es/photozserver.md'
              #- Almacenamiento: 'es/armazenamento.md'
              #- Monitoreo: 'es/monitoramento.md'
              - Cursos y Tutoriales: 'es/cursos.md'
              - Glosario: 'es/glossario.md'
              - Soporte: 'es/suporte.md'
              #- Preguntas Frecuentes: 'es/faq.md'
              #- Ejemplos Mkdocs: 'es/exemplos/exemplos.md' #provisional
    - search:
        enabled: true
    - git-revision-date-localized:
        type: date
    #- mkdocs-video