Files
Artemis/mkdocs.yml
Marco Dalla Tiezza 0b416f0a2e Docs update
2024-06-13 23:55:41 +02:00

82 lines
2.2 KiB
YAML

site_name: ARTEMIS
repo_url: https://github.com/AresValley/Artemis
theme:
name: material
favicon: assets/artemis_icon.ico
logo: assets/logo_small_white.svg
font:
text: Roboto
palette:
- scheme: default
primary: black
toggle:
icon: material/lightbulb
name: Switch to dark mode
- scheme: slate
primary: black
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
features:
content.code.copy
content.tooltips
markdown_extensions:
- pymdownx.arithmatex:
generic: true
- admonition
- pymdownx.details
- pymdownx.superfences
- tables
- abbr
- attr_list
- pymdownx.snippets
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra_javascript:
- javascripts/katex.js
- https://unpkg.com/katex@0/dist/katex.min.js
- https://unpkg.com/katex@0/dist/contrib/auto-render.min.js
extra_css:
- https://unpkg.com/katex@0/dist/katex.min.css
nav:
- Welcome: 'index.md'
- Getting Started:
- Installation: 'installation.md'
- Run from source: 'run_from_source.md'
- Build Package: 'build_package.md'
- Basic Operations: 'basic_operations.md'
- Database:
- Overview: 'database/db_overview.md'
- Structure:
- Info: 'database/db_info.md'
- Signals: 'database/db_signals.md'
- Frequency: 'database/db_frequency.md'
- Bandwidth: 'database/db_bandwidth.md'
- Modulation: 'database/db_modulation.md'
- Mode: 'database/db_mode.md'
- Location: 'database/db_location.md'
- Category: 'database/db_category.md'
- Category Label: 'database/db_cat_label.md'
- ACF: 'database/db_acf.md'
- SigID: 'database/sigid.md'
- Space Weather:
- Current: 'space_weather/current.md'
- Forecasts: 'space_weather/forecasts.md'
- DRAP: 'space_weather/drap.md'
- Aurora: 'space_weather/aurora.md'
- Signal Analysis:
- Autocorrelation (ACF): 'acf_analysis.md'
- FAQ: 'faq.md'
- Contribute: 'contribute.md'
- Changelog: https://github.com/AresValley/Artemis/blob/master/CHANGELOG.md
- License & Credits: 'credits.md'