-
Notifications
You must be signed in to change notification settings - Fork 3
/
mkdocs.yml
220 lines (212 loc) · 7.77 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
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
site_name: VAST Pipeline
site_description: >-
VAST Pipeline platform to enable processing of astronomical sources
extracted from the ASKAP telescope for radio transient detection science
site_author: VAST Development Team
site_url: https://vast-survey.org/vast-pipeline/
copyright: Copyright © 2020 - 2025 Vast Development Team, University of Sydney - all right reserved
repo_url: https://github.com/askap-vast/vast-pipeline
repo_name: askap-vast/vast-pipeline
edit_uri: "tree/dev/docs/"
dev_addr: localhost:8008
docs_dir: docs
site_dir: docs_build
theme:
name: material
favicon: img/favicon.png
logo: img/vast-logo.png
features:
- navigation.instant
- navigation.tabs
- navigation.sections
custom_dir: docs/theme
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
accent: blue
toggle:
icon: material/toggle-switch
name: Switch to light mode
# Extensions
extra_css:
- theme/css/extra.css
extra_javascript:
- theme/js/extra.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
markdown_extensions:
- admonition
- attr_list
- pymdownx.arithmatex:
generic: true
- pymdownx.caret
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences
- pymdownx.highlight
- pymdownx.tabbed
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- toc:
toc_depth: 4
permalink: true
- lightgallery
nav:
- Home: index.md
- Getting Started:
- Installation: gettingstarted/installation.md
- Configuration: gettingstarted/configuration.md
- Deployment: gettingstarted/deployment.md
- Using the Pipeline:
- Required Data: using/requireddata.md
- Accessing the Pipeline: using/access.md
- Initialising a Run: using/initrun.md
- Run Configuration: using/runconfig.md
- Processing a Run: using/processrun.md
- Adding Images to a Run: using/addtorun.md
- Restoring a Run: using/restorerun.md
- Deleting a Run: using/deleterun.md
- Generating Arrow Files: using/genarrow.md
- Exploring the Pipeline Website:
- Website Overview: exploringwebsite/websiteoverview.md
- DataTables: exploringwebsite/datatables.md
- Pipeline Run Pages: exploringwebsite/runpages.md
- Source Query: exploringwebsite/sourcequery.md
- Source η-V Analysis: exploringwebsite/sourceanalysis.md
- Source Detail: exploringwebsite/sourcedetail.md
- Source Tags & Favourites: exploringwebsite/sourcetagsfavs.md
- Measurement Pages: exploringwebsite/measurementpages.md
- Image Pages: exploringwebsite/imagepages.md
- Pipeline Outputs:
- Outputs Overview: outputs/outputs.md
- Using the Outputs: outputs/usingoutputs.md
- Column Descriptions: outputs/coldesc.md
- Admin Usage:
- CLI: adminusage/cli.md
- Standalone Image Ingestion: adminusage/ingestimages.md
- Web App: adminusage/app.md
- Web App Admin Tools: exploringwebsite/admintools.md
- Features & Design:
- Pipeline Steps Overview: design/overview.md
- Image & Selavy Catalogue Ingest: design/imageingest.md
- Source Association: design/association.md
- New Sources: design/newsources.md
- Forced Measurements: design/monitor.md
- Source Statistics: design/sourcestats.md
- Architecture:
- Architecture Overview: architecture/intro.md
- Database Schema: architecture/database.md
# - Production: architecture/nimbus.md
- Contributing and Developing:
- Development Guidlines: developing/intro.md
- GitHub Platform: developing/github.md
- Local Development Environment: developing/localdevenv.md
- Tests: developing/tests.md
- Documentation: developing/docsdev.md
- Benchmarks: developing/profiling.md
# - Tips: developing/tips.md like this https://stackoverflow.com/questions/60160823/how-to-properly-parallelize-generic-code-with-numba-dask
- FAQ: faq.md
- Help and Acknowledgements: help_and_acknowledgements.md
- Reference:
- Changelog: changelog.md
- Code of Conduct: code_of_conduct.md
- License: license.md
- Code Reference:
- vast_pipeline:
- image:
- main.py: reference/image/main.md
- utils.py: reference/image/utils.md
- management:
- commands:
- clearpiperun.py: reference/management/commands/clearpiperun.md
- createmeasarrow.py: reference/management/commands/createmeasarrow.md
- debugrun.py: reference/management/commands/debugrun.md
- ingestimages.py: reference/management/commands/ingestimages.md
- initingest.py: reference/management/commands/initingest.md
- initpiperun.py: reference/management/commands/initpiperun.md
- restorepiperun.py: reference/management/commands/restorepiperun.md
- runpipeline.py: reference/management/commands/runpipeline.md
- helpers.py: reference/management/helpers.md
- pipeline:
- association.py: reference/pipeline/association.md
- config.py: reference/pipeline/config.md
- errors.py: reference/pipeline/errors.md
- finalise.py: reference/pipeline/finalise.md
- forced_extraction.py: reference/pipeline/forced_extraction.md
- loading.py: reference/pipeline/loading.md
- main.py: reference/pipeline/main.md
- model_generator.py: reference/pipeline/model_generator.md
- new_sources.py: reference/pipeline/new_sources.md
- pairs.py: reference/pipeline/pairs.md
- utils.py: reference/pipeline/utils.md
- survey:
- translators.py: reference/survey/translators.md
- utils:
- auth.py: reference/utils/auth.md
- external_query.py: reference/utils/external_query.md
- unit_tags.py: reference/utils/unit_tags.md
- utils.py: reference/utils/utils.md
- view.py: reference/utils/view.md
- admin.py: reference/admin.md
- apps.py: reference/apps.md
- context_processors.py: reference/context_processors.md
- converters.py: reference/converters.md
- forms.py: reference/forms.md
- models.py: reference/models.md
- plots.py: reference/plots.md
- serializers.py: reference/serializers.md
- signals.py: reference/signals.md
- urls.py: reference/urls.md
- views.py: reference/views.md
plugins:
- search
- git-revision-date-localized:
fallback_to_build_date: true
enable_creation_date: true
exclude:
- index.md
- gen-files:
scripts:
# - docs/gen_credits.py
- docs/gen_doc_stubs.py
- minify:
minify_html: true
minify_js: true
htmlmin_opts:
remove_comments: true
js_files:
- theme/js/extra.js
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
show_source: true
setup_commands:
- "import os"
- "import django"
- "os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'webinterface.settings')"
- "os.environ.setdefault('DATABASE_URL', '')"
- "django.setup()"
watch:
- vast_pipeline
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/askap-vast/vast-pipeline
name: vast-pipeline source on GitHub
- icon: fontawesome/solid/globe
link: https://vast-survey.org
version:
provider: mike