diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index d00bad7..a8fd9a4 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -29,7 +29,7 @@ jobs: - name: Setup packages run: | sudo apt install python3-sphinx make - python -m pip install sphinx-press-theme myst-parser + python -m pip install sphinx-rtd-theme sphinx-sitemap - name: Build run: make html diff --git a/README.md b/README.md index bdc3790..bd22ffb 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,5 @@ -# Audiotool Documentation +# Audiotool Manual -## Setup +This is the repository of the official audiotool manual - read at [manual.audiotool.com](https://manual.audiotool.com). -### Setup dependencies - -* install sphinx: `sudo apt install python3-sphinx` -* install theme: `python3 -m pip install sphinx-press-theme` -* install markdown parser: `python3 -m pip install myst-parser` - -### Build - -``` -make html -``` - - -### View - -``` -cd _build/html && python3 -m http.server -``` - -## Todo: - -Until launch: - -- [ ] Write introductory texts -- [ ] Decide on weather to use reStructured or Markdown -- [ ] Rename old plugin names (beatbox 8, 9), clean up titles (like `Matrix (draft)`) -- [ ] Add static domain name `docs.audiotool.com` -- [ ] Link from homepage to docs -- [ ] Add page "Contribute" -- [ ] Add "Space" documentation -- [ ] Add Booster page - -Then: -- [ ] Fix non-consecutive header issue (if staying with markdown) -- [ ] Work over & clean up texts -- [ ] Add an image to every audio effect -- [ ] Add videos to relevant articles? \ No newline at end of file +Head over to [How to Contribute](https://manual.audiotool.com/manuals/other/contribute.html) if you'd like to contribute! diff --git a/conf.py b/conf.py index 60c200a..17ebf70 100644 --- a/conf.py +++ b/conf.py @@ -18,8 +18,8 @@ # -- Project information ----------------------------------------------------- project = 'Audiotool' -copyright = '2023, Audiotool Inc.' -author = 'Audiotool Inc.' +copyright = '2023, Audiotool Inc' +author = 'Audiotool Inc' # The full version, including alpha/beta/rc tags release = '0.1' @@ -31,9 +31,12 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - "myst_parser" + 'sphinx.ext.autosectionlabel', + 'sphinx_sitemap' ] -myst_heading_anchors = 1 + +# sphinx_sitemap config +sitemap_url_scheme = "{link}" # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -46,7 +49,6 @@ source_suffix = { '.rst': 'restructuredtext', '.txt': 'restructuredtext', - '.md': 'markdown', } @@ -54,17 +56,53 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# -html_theme = 'press' + + +html_theme = 'sphinx_rtd_theme' html_theme_options = { - "external_links": [ - ("Contribute", "https://github.com/audiotool/docs") - ] + 'analytics_id': 'G-JBQGMZED6F', + 'logo_only': False, + 'display_version': False, + + # where "prev"/"next" buttons are shown; bottom, top or both + 'prev_next_buttons_location': 'bottom', + + 'sticky_navigation': False, + + # add arrow symbol to links pointing outside docs + 'style_external_links': True, + + # weather to keep "+" symbols on left bar + 'collapse_navigation': False, + +} + +# Configure "edit on github" at top right +html_context = { + "display_github": True, + "github_user": "Audiotool", + "github_repo": "docs", + "github_version": "master", + "conf_py_path": "/", } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] \ No newline at end of file +html_static_path = ['static'] + +# Custom css files to include +html_css_files = [ + "custom.css" +] +html_js_files = [ + 'custom.js', +] + +html_show_sphinx = False + +html_baseurl = 'https://manual.audiotool.com/' + +# logo_url = "https://images.g2crowd.com/uploads/product/image/social_landscape/social_landscape_d05ec3744972a3774cc038fe42484954/audiotool.png" diff --git a/images/App-Shot-s.png b/images/App-Shot-s.png new file mode 100644 index 0000000..6336527 Binary files /dev/null and b/images/App-Shot-s.png differ diff --git a/images/BPM-automation-indicator.png b/images/BPM-automation-indicator.png new file mode 100644 index 0000000..53358f1 Binary files /dev/null and b/images/BPM-automation-indicator.png differ diff --git a/images/BPM-automation.png b/images/BPM-automation.png new file mode 100644 index 0000000..f273e44 Binary files /dev/null and b/images/BPM-automation.png differ diff --git a/images/Desktop-Shot.png b/images/Desktop-Shot.png new file mode 100644 index 0000000..e21f590 Binary files /dev/null and b/images/Desktop-Shot.png differ diff --git a/images/Device-Cloud.gif b/images/Device-Cloud.gif new file mode 100644 index 0000000..dbfe7fd Binary files /dev/null and b/images/Device-Cloud.gif differ diff --git a/images/Device-Cloud.png b/images/Device-Cloud.png new file mode 100644 index 0000000..9593509 Binary files /dev/null and b/images/Device-Cloud.png differ diff --git a/images/Invite-Shot-s.png b/images/Invite-Shot-s.png new file mode 100644 index 0000000..56d81ba Binary files /dev/null and b/images/Invite-Shot-s.png differ diff --git a/images/Invite-icon.png b/images/Invite-icon.png new file mode 100644 index 0000000..957c313 Binary files /dev/null and b/images/Invite-icon.png differ diff --git a/images/Invite-popup.png b/images/Invite-popup.png new file mode 100644 index 0000000..ca8930e Binary files /dev/null and b/images/Invite-popup.png differ diff --git a/images/Learn-Midi-Controller.png b/images/Learn-Midi-Controller.png new file mode 100644 index 0000000..5ce6892 Binary files /dev/null and b/images/Learn-Midi-Controller.png differ diff --git a/images/Microtuning-Shot.png b/images/Microtuning-Shot.png new file mode 100644 index 0000000..bde0738 Binary files /dev/null and b/images/Microtuning-Shot.png differ diff --git a/images/Midi-Icon.png b/images/Midi-Icon.png new file mode 100644 index 0000000..fd72869 Binary files /dev/null and b/images/Midi-Icon.png differ diff --git a/images/SWKeyboard-Shot.png b/images/SWKeyboard-Shot.png new file mode 100644 index 0000000..3594d4b Binary files /dev/null and b/images/SWKeyboard-Shot.png differ diff --git a/images/SWKeyboard-icon.png b/images/SWKeyboard-icon.png new file mode 100644 index 0000000..c45dee4 Binary files /dev/null and b/images/SWKeyboard-icon.png differ diff --git a/images/Sample-Browser-Shot.png b/images/Sample-Browser-Shot.png new file mode 100644 index 0000000..8cc5256 Binary files /dev/null and b/images/Sample-Browser-Shot.png differ diff --git a/images/ar-01.jpg b/images/ar-01.jpg new file mode 100644 index 0000000..35df7e1 Binary files /dev/null and b/images/ar-01.jpg differ diff --git a/images/ar-02.jpg b/images/ar-02.jpg new file mode 100644 index 0000000..d24df64 Binary files /dev/null and b/images/ar-02.jpg differ diff --git a/images/ar-03.jpg b/images/ar-03.jpg new file mode 100644 index 0000000..aebe461 Binary files /dev/null and b/images/ar-03.jpg differ diff --git a/images/ar-05.jpg b/images/ar-05.jpg new file mode 100644 index 0000000..9c1974b Binary files /dev/null and b/images/ar-05.jpg differ diff --git a/images/ar-06.jpg b/images/ar-06.jpg new file mode 100644 index 0000000..3a35bac Binary files /dev/null and b/images/ar-06.jpg differ diff --git a/images/arranging-in-timeline.gif b/images/arranging-in-timeline.gif new file mode 100644 index 0000000..f56506f Binary files /dev/null and b/images/arranging-in-timeline.gif differ diff --git a/images/audio_regions_numbered.png b/images/audio_regions_numbered.png new file mode 100644 index 0000000..de9ac68 Binary files /dev/null and b/images/audio_regions_numbered.png differ diff --git a/images/audio_track_device_in_device_list.png b/images/audio_track_device_in_device_list.png new file mode 100644 index 0000000..491447c Binary files /dev/null and b/images/audio_track_device_in_device_list.png differ diff --git a/images/audio_track_overview.png b/images/audio_track_overview.png new file mode 100644 index 0000000..ba5a29b Binary files /dev/null and b/images/audio_track_overview.png differ diff --git a/images/audiotool_com_top_bar.png b/images/audiotool_com_top_bar.png new file mode 100644 index 0000000..8a9da8e Binary files /dev/null and b/images/audiotool_com_top_bar.png differ diff --git a/images/audiotool_splash_screen.png b/images/audiotool_splash_screen.png new file mode 100644 index 0000000..b891c9d Binary files /dev/null and b/images/audiotool_splash_screen.png differ diff --git a/images/audiotrack.png b/images/audiotrack.png new file mode 100644 index 0000000..c721e4f Binary files /dev/null and b/images/audiotrack.png differ diff --git a/images/autofilter1.png b/images/autofilter1.png new file mode 100644 index 0000000..f820cc6 Binary files /dev/null and b/images/autofilter1.png differ diff --git a/images/autofilter2.png b/images/autofilter2.png new file mode 100644 index 0000000..300ed1d Binary files /dev/null and b/images/autofilter2.png differ diff --git a/images/bandsplitter.png b/images/bandsplitter.png new file mode 100644 index 0000000..c8bddc9 Binary files /dev/null and b/images/bandsplitter.png differ diff --git a/images/bassline.png b/images/bassline.png new file mode 100644 index 0000000..6b83b1f Binary files /dev/null and b/images/bassline.png differ diff --git a/images/bassline1.png b/images/bassline1.png new file mode 100644 index 0000000..141de03 Binary files /dev/null and b/images/bassline1.png differ diff --git a/images/bassline2.png b/images/bassline2.png new file mode 100644 index 0000000..3c88cca Binary files /dev/null and b/images/bassline2.png differ diff --git a/images/bassline3.png b/images/bassline3.png new file mode 100644 index 0000000..1dce71c Binary files /dev/null and b/images/bassline3.png differ diff --git a/images/beat_eight.png b/images/beat_eight.png new file mode 100644 index 0000000..010f819 Binary files /dev/null and b/images/beat_eight.png differ diff --git a/images/beat_eight2.png b/images/beat_eight2.png new file mode 100644 index 0000000..01119d7 Binary files /dev/null and b/images/beat_eight2.png differ diff --git a/images/beat_eight3.png b/images/beat_eight3.png new file mode 100644 index 0000000..241b169 Binary files /dev/null and b/images/beat_eight3.png differ diff --git a/images/beatbox2.png b/images/beatbox2.png new file mode 100644 index 0000000..17a2fb4 Binary files /dev/null and b/images/beatbox2.png differ diff --git a/images/beatbox3.png b/images/beatbox3.png new file mode 100644 index 0000000..337ac00 Binary files /dev/null and b/images/beatbox3.png differ diff --git a/images/beatbox91.png b/images/beatbox91.png new file mode 100644 index 0000000..3f3f6c8 Binary files /dev/null and b/images/beatbox91.png differ diff --git a/images/booster_connected.png b/images/booster_connected.png new file mode 100644 index 0000000..f7e126c Binary files /dev/null and b/images/booster_connected.png differ diff --git a/images/centroid1.png b/images/centroid1.png new file mode 100644 index 0000000..16f2f92 Binary files /dev/null and b/images/centroid1.png differ diff --git a/images/centroid2.png b/images/centroid2.png new file mode 100644 index 0000000..deff7dd Binary files /dev/null and b/images/centroid2.png differ diff --git a/images/centroid4.png b/images/centroid4.png new file mode 100644 index 0000000..87d0790 Binary files /dev/null and b/images/centroid4.png differ diff --git a/images/centroid5.png b/images/centroid5.png new file mode 100644 index 0000000..c75e430 Binary files /dev/null and b/images/centroid5.png differ diff --git a/images/centroid_insert_channel_righclick.png b/images/centroid_insert_channel_righclick.png new file mode 100644 index 0000000..8630cb6 Binary files /dev/null and b/images/centroid_insert_channel_righclick.png differ diff --git a/images/chorus.png b/images/chorus.png new file mode 100644 index 0000000..c0b24aa Binary files /dev/null and b/images/chorus.png differ diff --git a/images/compressor.png b/images/compressor.png new file mode 100644 index 0000000..26d05d5 Binary files /dev/null and b/images/compressor.png differ diff --git a/images/crossfader.png b/images/crossfader.png new file mode 100644 index 0000000..3e2d612 Binary files /dev/null and b/images/crossfader.png differ diff --git a/images/crusher.png b/images/crusher.png new file mode 100644 index 0000000..3695c80 Binary files /dev/null and b/images/crusher.png differ diff --git a/images/curve.png b/images/curve.png new file mode 100644 index 0000000..b31bbb5 Binary files /dev/null and b/images/curve.png differ diff --git a/images/delay.png b/images/delay.png new file mode 100644 index 0000000..10e0e13 Binary files /dev/null and b/images/delay.png differ diff --git a/images/desktop.png b/images/desktop.png new file mode 100644 index 0000000..1146680 Binary files /dev/null and b/images/desktop.png differ diff --git a/images/drag-pulv-to-desktop.gif b/images/drag-pulv-to-desktop.gif new file mode 100644 index 0000000..604a10b Binary files /dev/null and b/images/drag-pulv-to-desktop.gif differ diff --git a/images/drag-sample-to-desktop.gif b/images/drag-sample-to-desktop.gif new file mode 100644 index 0000000..18a667e Binary files /dev/null and b/images/drag-sample-to-desktop.gif differ diff --git a/images/eq1.png b/images/eq1.png new file mode 100644 index 0000000..f382ee5 Binary files /dev/null and b/images/eq1.png differ diff --git a/images/eq2.png b/images/eq2.png new file mode 100644 index 0000000..829bf64 Binary files /dev/null and b/images/eq2.png differ diff --git a/images/eq_wave2.png b/images/eq_wave2.png new file mode 100644 index 0000000..636c3cf Binary files /dev/null and b/images/eq_wave2.png differ diff --git a/images/exciter.png b/images/exciter.png new file mode 100644 index 0000000..d751eeb Binary files /dev/null and b/images/exciter.png differ diff --git a/images/exciter2.png b/images/exciter2.png new file mode 100644 index 0000000..f49e80c Binary files /dev/null and b/images/exciter2.png differ diff --git a/images/flanger.png b/images/flanger.png new file mode 100644 index 0000000..af09d71 Binary files /dev/null and b/images/flanger.png differ diff --git a/images/gate.png b/images/gate.png new file mode 100644 index 0000000..c8afd38 Binary files /dev/null and b/images/gate.png differ diff --git a/images/gravity.png b/images/gravity.png new file mode 100644 index 0000000..3ec4ac8 Binary files /dev/null and b/images/gravity.png differ diff --git a/images/hei1.png b/images/hei1.png new file mode 100644 index 0000000..05f5b91 Binary files /dev/null and b/images/hei1.png differ diff --git a/images/hei_env3.png b/images/hei_env3.png new file mode 100644 index 0000000..8696a40 Binary files /dev/null and b/images/hei_env3.png differ diff --git a/images/hei_filter1.png b/images/hei_filter1.png new file mode 100644 index 0000000..2623d6e Binary files /dev/null and b/images/hei_filter1.png differ diff --git a/images/hei_lfo1.png b/images/hei_lfo1.png new file mode 100644 index 0000000..214d2cf Binary files /dev/null and b/images/hei_lfo1.png differ diff --git a/images/hei_master2.png b/images/hei_master2.png new file mode 100644 index 0000000..967aa62 Binary files /dev/null and b/images/hei_master2.png differ diff --git a/images/hei_operator2.png b/images/hei_operator2.png new file mode 100644 index 0000000..cd3b1bc Binary files /dev/null and b/images/hei_operator2.png differ diff --git a/images/hei_pitch_env2.png b/images/hei_pitch_env2.png new file mode 100644 index 0000000..0059b22 Binary files /dev/null and b/images/hei_pitch_env2.png differ diff --git a/images/helmholtz.png b/images/helmholtz.png new file mode 100644 index 0000000..f9943df Binary files /dev/null and b/images/helmholtz.png differ diff --git a/images/kobolt.png b/images/kobolt.png new file mode 100644 index 0000000..c0ea2cf Binary files /dev/null and b/images/kobolt.png differ diff --git a/images/machiniste1.png b/images/machiniste1.png new file mode 100644 index 0000000..cc24d65 Binary files /dev/null and b/images/machiniste1.png differ diff --git a/images/machiniste3.png b/images/machiniste3.png new file mode 100644 index 0000000..1e27ed7 Binary files /dev/null and b/images/machiniste3.png differ diff --git a/images/machiniste4.png b/images/machiniste4.png new file mode 100644 index 0000000..807d382 Binary files /dev/null and b/images/machiniste4.png differ diff --git a/images/machiniste5.png b/images/machiniste5.png new file mode 100644 index 0000000..d89cf02 Binary files /dev/null and b/images/machiniste5.png differ diff --git a/images/main-controls.png b/images/main-controls.png new file mode 100644 index 0000000..274293c Binary files /dev/null and b/images/main-controls.png differ diff --git a/images/matrix_arpeggiator.png b/images/matrix_arpeggiator.png new file mode 100644 index 0000000..222b690 Binary files /dev/null and b/images/matrix_arpeggiator.png differ diff --git a/images/merger.png b/images/merger.png new file mode 100644 index 0000000..b71922f Binary files /dev/null and b/images/merger.png differ diff --git a/images/minimixer+reverb.png b/images/minimixer+reverb.png new file mode 100644 index 0000000..75b6488 Binary files /dev/null and b/images/minimixer+reverb.png differ diff --git a/images/minimixer.png b/images/minimixer.png new file mode 100644 index 0000000..9c9ed86 Binary files /dev/null and b/images/minimixer.png differ diff --git a/images/mix/crossfader.webp b/images/mix/crossfader.webp new file mode 100644 index 0000000..71db990 Binary files /dev/null and b/images/mix/crossfader.webp differ diff --git a/images/mix/cue_controls.webp b/images/mix/cue_controls.webp new file mode 100644 index 0000000..02dac35 Binary files /dev/null and b/images/mix/cue_controls.webp differ diff --git a/images/mix/eq.webp b/images/mix/eq.webp new file mode 100644 index 0000000..f49426b Binary files /dev/null and b/images/mix/eq.webp differ diff --git a/images/mix/jogweels.webp b/images/mix/jogweels.webp new file mode 100644 index 0000000..12624c8 Binary files /dev/null and b/images/mix/jogweels.webp differ diff --git a/images/mix/loop_sync_nudge.webp b/images/mix/loop_sync_nudge.webp new file mode 100644 index 0000000..c1d0cab Binary files /dev/null and b/images/mix/loop_sync_nudge.webp differ diff --git a/images/mix/menu_layout.webp b/images/mix/menu_layout.webp new file mode 100644 index 0000000..e6541d7 Binary files /dev/null and b/images/mix/menu_layout.webp differ diff --git a/images/mix/menu_midi_mapping.webp b/images/mix/menu_midi_mapping.webp new file mode 100644 index 0000000..b76f190 Binary files /dev/null and b/images/mix/menu_midi_mapping.webp differ diff --git a/images/mix/menu_midi_mapping_open.webp b/images/mix/menu_midi_mapping_open.webp new file mode 100644 index 0000000..9a2a8dc Binary files /dev/null and b/images/mix/menu_midi_mapping_open.webp differ diff --git a/images/mix/menu_output.webp b/images/mix/menu_output.webp new file mode 100644 index 0000000..bdd3ce1 Binary files /dev/null and b/images/mix/menu_output.webp differ diff --git a/images/mix/menu_renderer.webp b/images/mix/menu_renderer.webp new file mode 100644 index 0000000..c880189 Binary files /dev/null and b/images/mix/menu_renderer.webp differ diff --git a/images/mix/menu_themes.webp b/images/mix/menu_themes.webp new file mode 100644 index 0000000..29f6d37 Binary files /dev/null and b/images/mix/menu_themes.webp differ diff --git a/images/mix/mix.webp b/images/mix/mix.webp new file mode 100644 index 0000000..7a52ca3 Binary files /dev/null and b/images/mix/mix.webp differ diff --git a/images/mix/player_displays.webp b/images/mix/player_displays.webp new file mode 100644 index 0000000..78b2d9c Binary files /dev/null and b/images/mix/player_displays.webp differ diff --git a/images/mix/tracklist_empty.webp b/images/mix/tracklist_empty.webp new file mode 100644 index 0000000..26d5bc7 Binary files /dev/null and b/images/mix/tracklist_empty.webp differ diff --git a/images/mix/tracklist_local.webp b/images/mix/tracklist_local.webp new file mode 100644 index 0000000..6031840 Binary files /dev/null and b/images/mix/tracklist_local.webp differ diff --git a/images/mix/tracklist_open.webp b/images/mix/tracklist_open.webp new file mode 100644 index 0000000..2b6ee16 Binary files /dev/null and b/images/mix/tracklist_open.webp differ diff --git a/images/mix/tracklist_seachresult.webp b/images/mix/tracklist_seachresult.webp new file mode 100644 index 0000000..4cfd2d8 Binary files /dev/null and b/images/mix/tracklist_seachresult.webp differ diff --git a/images/mix/trim_master.webp b/images/mix/trim_master.webp new file mode 100644 index 0000000..2b2067e Binary files /dev/null and b/images/mix/trim_master.webp differ diff --git a/images/notesplitter.png b/images/notesplitter.png new file mode 100644 index 0000000..839e722 Binary files /dev/null and b/images/notesplitter.png differ diff --git a/images/panel.png b/images/panel.png new file mode 100644 index 0000000..798bb7c Binary files /dev/null and b/images/panel.png differ diff --git a/images/panorama.png b/images/panorama.png new file mode 100644 index 0000000..f46ae5d Binary files /dev/null and b/images/panorama.png differ diff --git a/images/pdelay.png b/images/pdelay.png new file mode 100644 index 0000000..e6c6717 Binary files /dev/null and b/images/pdelay.png differ diff --git a/images/peq.png b/images/peq.png new file mode 100644 index 0000000..b75af05 Binary files /dev/null and b/images/peq.png differ diff --git a/images/phaser.png b/images/phaser.png new file mode 100644 index 0000000..46ec91a Binary files /dev/null and b/images/phaser.png differ diff --git a/images/placing-editing-notes.gif b/images/placing-editing-notes.gif new file mode 100644 index 0000000..068dffe Binary files /dev/null and b/images/placing-editing-notes.gif differ diff --git a/images/playback_speed_automation_0.png b/images/playback_speed_automation_0.png new file mode 100644 index 0000000..ed53646 Binary files /dev/null and b/images/playback_speed_automation_0.png differ diff --git a/images/playback_speed_automation_1.png b/images/playback_speed_automation_1.png new file mode 100644 index 0000000..ae65b80 Binary files /dev/null and b/images/playback_speed_automation_1.png differ diff --git a/images/playback_speed_automation_2.png b/images/playback_speed_automation_2.png new file mode 100644 index 0000000..6a0b8cc Binary files /dev/null and b/images/playback_speed_automation_2.png differ diff --git a/images/publish-dialog.png b/images/publish-dialog.png new file mode 100644 index 0000000..d33cd1a Binary files /dev/null and b/images/publish-dialog.png differ diff --git a/images/pulsar.png b/images/pulsar.png new file mode 100644 index 0000000..652c019 Binary files /dev/null and b/images/pulsar.png differ diff --git a/images/pulverisateur1.png b/images/pulverisateur1.png new file mode 100644 index 0000000..7a0e74d Binary files /dev/null and b/images/pulverisateur1.png differ diff --git a/images/pulverisateur2.png b/images/pulverisateur2.png new file mode 100644 index 0000000..d279a28 Binary files /dev/null and b/images/pulverisateur2.png differ diff --git a/images/pulverisateur3.png b/images/pulverisateur3.png new file mode 100644 index 0000000..8a0cd57 Binary files /dev/null and b/images/pulverisateur3.png differ diff --git a/images/pulverisateur4.png b/images/pulverisateur4.png new file mode 100644 index 0000000..1f5c11c Binary files /dev/null and b/images/pulverisateur4.png differ diff --git a/images/pulverisateur5.png b/images/pulverisateur5.png new file mode 100644 index 0000000..d1effab Binary files /dev/null and b/images/pulverisateur5.png differ diff --git a/images/pulverisateur6.png b/images/pulverisateur6.png new file mode 100644 index 0000000..c037f7c Binary files /dev/null and b/images/pulverisateur6.png differ diff --git a/images/pulverisateur7.png b/images/pulverisateur7.png new file mode 100644 index 0000000..01fa6d0 Binary files /dev/null and b/images/pulverisateur7.png differ diff --git a/images/pulverisateur8.png b/images/pulverisateur8.png new file mode 100644 index 0000000..ef2600e Binary files /dev/null and b/images/pulverisateur8.png differ diff --git a/images/pulverisateur9.png b/images/pulverisateur9.png new file mode 100644 index 0000000..b9249d1 Binary files /dev/null and b/images/pulverisateur9.png differ diff --git a/images/quantum.png b/images/quantum.png new file mode 100644 index 0000000..d711ca7 Binary files /dev/null and b/images/quantum.png differ diff --git a/images/rasselbock1.png b/images/rasselbock1.png new file mode 100644 index 0000000..86333f8 Binary files /dev/null and b/images/rasselbock1.png differ diff --git a/images/rasselbock2.png b/images/rasselbock2.png new file mode 100644 index 0000000..4f4400a Binary files /dev/null and b/images/rasselbock2.png differ diff --git a/images/rasselbock3.png b/images/rasselbock3.png new file mode 100644 index 0000000..b16ff36 Binary files /dev/null and b/images/rasselbock3.png differ diff --git a/images/rasselbock4.png b/images/rasselbock4.png new file mode 100644 index 0000000..409ef79 Binary files /dev/null and b/images/rasselbock4.png differ diff --git a/images/reverb-diffuse.png b/images/reverb-diffuse.png new file mode 100644 index 0000000..9b10372 Binary files /dev/null and b/images/reverb-diffuse.png differ diff --git a/images/reverb-full.png b/images/reverb-full.png new file mode 100644 index 0000000..11647b8 Binary files /dev/null and b/images/reverb-full.png differ diff --git a/images/reverb-input.png b/images/reverb-input.png new file mode 100644 index 0000000..ec85566 Binary files /dev/null and b/images/reverb-input.png differ diff --git a/images/reverb-output.png b/images/reverb-output.png new file mode 100644 index 0000000..db3f337 Binary files /dev/null and b/images/reverb-output.png differ diff --git a/images/reverb-plate.png b/images/reverb-plate.png new file mode 100644 index 0000000..96dcfe7 Binary files /dev/null and b/images/reverb-plate.png differ diff --git a/images/reverb-preview.png b/images/reverb-preview.png new file mode 100644 index 0000000..7f94b7f Binary files /dev/null and b/images/reverb-preview.png differ diff --git a/images/reverb-vibrato.png b/images/reverb-vibrato.png new file mode 100644 index 0000000..4d6a32a Binary files /dev/null and b/images/reverb-vibrato.png differ diff --git a/images/reverb.png b/images/reverb.png new file mode 100644 index 0000000..2f2d66d Binary files /dev/null and b/images/reverb.png differ diff --git a/images/ringmod.png b/images/ringmod.png new file mode 100644 index 0000000..d0497d5 Binary files /dev/null and b/images/ringmod.png differ diff --git a/images/sample-in-panel.png b/images/sample-in-panel.png new file mode 100644 index 0000000..10e6ddd Binary files /dev/null and b/images/sample-in-panel.png differ diff --git a/images/sample-search.gif b/images/sample-search.gif new file mode 100644 index 0000000..758a924 Binary files /dev/null and b/images/sample-search.gif differ diff --git a/images/save-context.png b/images/save-context.png new file mode 100644 index 0000000..2fd3ee5 Binary files /dev/null and b/images/save-context.png differ diff --git a/images/save_project_dialogue.png b/images/save_project_dialogue.png new file mode 100644 index 0000000..033ffe4 Binary files /dev/null and b/images/save_project_dialogue.png differ diff --git a/images/save_project_popup.png b/images/save_project_popup.png new file mode 100644 index 0000000..3f0982b Binary files /dev/null and b/images/save_project_popup.png differ diff --git a/images/set_playback_mode_to_timestretch.png b/images/set_playback_mode_to_timestretch.png new file mode 100644 index 0000000..a1440cd Binary files /dev/null and b/images/set_playback_mode_to_timestretch.png differ diff --git a/images/simple-completed-project.png b/images/simple-completed-project.png new file mode 100644 index 0000000..c6fae54 Binary files /dev/null and b/images/simple-completed-project.png differ diff --git a/images/slope.png b/images/slope.png new file mode 100644 index 0000000..425bf84 Binary files /dev/null and b/images/slope.png differ diff --git a/images/space/10000000000002AD000001D414A86BBBC483C1ED.png b/images/space/10000000000002AD000001D414A86BBBC483C1ED.png new file mode 100644 index 0000000..f0a4e54 Binary files /dev/null and b/images/space/10000000000002AD000001D414A86BBBC483C1ED.png differ diff --git a/images/space/10000000000002AD000001D4316FCC45D85FE40B.png b/images/space/10000000000002AD000001D4316FCC45D85FE40B.png new file mode 100644 index 0000000..2979ddf Binary files /dev/null and b/images/space/10000000000002AD000001D4316FCC45D85FE40B.png differ diff --git a/images/space/10000000000002AD000001D48CCB814FFB0B80E4.png b/images/space/10000000000002AD000001D48CCB814FFB0B80E4.png new file mode 100644 index 0000000..caf4591 Binary files /dev/null and b/images/space/10000000000002AD000001D48CCB814FFB0B80E4.png differ diff --git a/images/space/10000201000002AD000001D40040919630530868.png b/images/space/10000201000002AD000001D40040919630530868.png new file mode 100644 index 0000000..53aa5aa Binary files /dev/null and b/images/space/10000201000002AD000001D40040919630530868.png differ diff --git a/images/space/10000201000002AD000001D414102E31040957F1.png b/images/space/10000201000002AD000001D414102E31040957F1.png new file mode 100644 index 0000000..ce0a307 Binary files /dev/null and b/images/space/10000201000002AD000001D414102E31040957F1.png differ diff --git a/images/space/10000201000002AD000001D446B039FDDDA0D4BE.png b/images/space/10000201000002AD000001D446B039FDDDA0D4BE.png new file mode 100644 index 0000000..eabf9c7 Binary files /dev/null and b/images/space/10000201000002AD000001D446B039FDDDA0D4BE.png differ diff --git a/images/space/10000201000002AD000001D4502847CB8DF2D3F6.png b/images/space/10000201000002AD000001D4502847CB8DF2D3F6.png new file mode 100644 index 0000000..4f45bbd Binary files /dev/null and b/images/space/10000201000002AD000001D4502847CB8DF2D3F6.png differ diff --git a/images/space/10000201000002AD000001D454C30E7D7D7F1156.png b/images/space/10000201000002AD000001D454C30E7D7D7F1156.png new file mode 100644 index 0000000..7e04ef1 Binary files /dev/null and b/images/space/10000201000002AD000001D454C30E7D7D7F1156.png differ diff --git a/images/space/10000201000002AD000001D4579BD7C8DBC7C0E2.png b/images/space/10000201000002AD000001D4579BD7C8DBC7C0E2.png new file mode 100644 index 0000000..c8bd0d5 Binary files /dev/null and b/images/space/10000201000002AD000001D4579BD7C8DBC7C0E2.png differ diff --git a/images/space/10000201000002AD000001D457AB937843B94177.png b/images/space/10000201000002AD000001D457AB937843B94177.png new file mode 100644 index 0000000..c872594 Binary files /dev/null and b/images/space/10000201000002AD000001D457AB937843B94177.png differ diff --git a/images/space/10000201000002AD000001D4822D7F5D54990B11.png b/images/space/10000201000002AD000001D4822D7F5D54990B11.png new file mode 100644 index 0000000..ee7b174 Binary files /dev/null and b/images/space/10000201000002AD000001D4822D7F5D54990B11.png differ diff --git a/images/space/10000201000002AD000001D4CBCF760D17EA3956.png b/images/space/10000201000002AD000001D4CBCF760D17EA3956.png new file mode 100644 index 0000000..cb887b5 Binary files /dev/null and b/images/space/10000201000002AD000001D4CBCF760D17EA3956.png differ diff --git a/images/space/10000201000002AD000001D4D142ACEFA7E36E41.png b/images/space/10000201000002AD000001D4D142ACEFA7E36E41.png new file mode 100644 index 0000000..18f8fe2 Binary files /dev/null and b/images/space/10000201000002AD000001D4D142ACEFA7E36E41.png differ diff --git a/images/space/10000201000002AD000001D4DEDE24071AC6426F.png b/images/space/10000201000002AD000001D4DEDE24071AC6426F.png new file mode 100644 index 0000000..fe22281 Binary files /dev/null and b/images/space/10000201000002AD000001D4DEDE24071AC6426F.png differ diff --git a/images/space/10000201000002AD000001D4DFA6DED4E3E20D51.png b/images/space/10000201000002AD000001D4DFA6DED4E3E20D51.png new file mode 100644 index 0000000..0d5da73 Binary files /dev/null and b/images/space/10000201000002AD000001D4DFA6DED4E3E20D51.png differ diff --git a/images/space/10000201000002AD000001D4EC8FC6464E514B85.png b/images/space/10000201000002AD000001D4EC8FC6464E514B85.png new file mode 100644 index 0000000..b58c858 Binary files /dev/null and b/images/space/10000201000002AD000001D4EC8FC6464E514B85.png differ diff --git a/images/space/10000201000002AD000001D4ED7CCDA82CFBD8C8.png b/images/space/10000201000002AD000001D4ED7CCDA82CFBD8C8.png new file mode 100644 index 0000000..bad1eee Binary files /dev/null and b/images/space/10000201000002AD000001D4ED7CCDA82CFBD8C8.png differ diff --git a/images/splitter.png b/images/splitter.png new file mode 100644 index 0000000..40126ce Binary files /dev/null and b/images/splitter.png differ diff --git a/images/stereo2.png b/images/stereo2.png new file mode 100644 index 0000000..1c0cb6f Binary files /dev/null and b/images/stereo2.png differ diff --git a/images/stereodetune.png b/images/stereodetune.png new file mode 100644 index 0000000..2563433 Binary files /dev/null and b/images/stereodetune.png differ diff --git a/images/stereoenhancer.png b/images/stereoenhancer.png new file mode 100644 index 0000000..62af167 Binary files /dev/null and b/images/stereoenhancer.png differ diff --git a/images/three_audio_regions.png b/images/three_audio_regions.png new file mode 100644 index 0000000..0eb2381 Binary files /dev/null and b/images/three_audio_regions.png differ diff --git a/images/timeline.png b/images/timeline.png new file mode 100644 index 0000000..4a436ec Binary files /dev/null and b/images/timeline.png differ diff --git a/images/tinygain.png b/images/tinygain.png new file mode 100644 index 0000000..7fe7d0f Binary files /dev/null and b/images/tinygain.png differ diff --git a/images/tonematrix01.png b/images/tonematrix01.png new file mode 100644 index 0000000..eb3d3df Binary files /dev/null and b/images/tonematrix01.png differ diff --git a/images/tube.png b/images/tube.png new file mode 100644 index 0000000..0786379 Binary files /dev/null and b/images/tube.png differ diff --git a/images/waveshaper.png b/images/waveshaper.png new file mode 100644 index 0000000..3d1abd2 Binary files /dev/null and b/images/waveshaper.png differ diff --git a/index.rst b/index.rst index 451ae80..3e43f04 100644 --- a/index.rst +++ b/index.rst @@ -1,99 +1,134 @@ -.. Audiotool documentation master file, created by - sphinx-quickstart on Thu Jun 1 14:37:04 2023. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -.. title:: Audiotool Documentation - Table of Contents +.. title:: Index .. meta:: :description: Audiotool Documentation - Table of Contents Audiotool ---------- +========= -Welcome to the documentation of `audiotool.com`_! +Welcome to the documentation of `audiotool.com `_! -.. _audiotool.com: https://www.audiotool.com +If this is your first time, check out the :ref:`getting started ` page or +watch the :ref:`first steps video series