audiotool · rasaichimori · Jun 1, 2023 · Jun 1, 2023 · Jun 1, 2023 · Jun 1, 2023
diff --git 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
@@ -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?
+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
@@ -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,25 +49,60 @@
 source_suffix = {
     '.rst': 'restructuredtext',
     '.txt': 'restructuredtext',
-    '.md': 'markdown',
 }
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # 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']
+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
diff --git a/images/BPM-automation-indicator.png b/images/BPM-automation-indicator.png
diff --git a/images/BPM-automation.png b/images/BPM-automation.png
diff --git a/images/Desktop-Shot.png b/images/Desktop-Shot.png
diff --git a/images/Device-Cloud.gif b/images/Device-Cloud.gif
diff --git a/images/Device-Cloud.png b/images/Device-Cloud.png
diff --git a/images/Invite-Shot-s.png b/images/Invite-Shot-s.png
diff --git a/images/Invite-icon.png b/images/Invite-icon.png
diff --git a/images/Invite-popup.png b/images/Invite-popup.png
diff --git a/images/Learn-Midi-Controller.png b/images/Learn-Midi-Controller.png
diff --git a/images/Microtuning-Shot.png b/images/Microtuning-Shot.png
diff --git a/images/Midi-Icon.png b/images/Midi-Icon.png
diff --git a/images/SWKeyboard-Shot.png b/images/SWKeyboard-Shot.png
diff --git a/images/SWKeyboard-icon.png b/images/SWKeyboard-icon.png
diff --git a/images/Sample-Browser-Shot.png b/images/Sample-Browser-Shot.png
diff --git a/images/ar-01.jpg b/images/ar-01.jpg
diff --git a/images/ar-02.jpg b/images/ar-02.jpg
diff --git a/images/ar-03.jpg b/images/ar-03.jpg
diff --git a/images/ar-05.jpg b/images/ar-05.jpg
diff --git a/images/ar-06.jpg b/images/ar-06.jpg
diff --git a/images/arranging-in-timeline.gif b/images/arranging-in-timeline.gif
diff --git a/images/audio_regions_numbered.png b/images/audio_regions_numbered.png
diff --git a/images/audio_track_device_in_device_list.png b/images/audio_track_device_in_device_list.png
diff --git a/images/audio_track_overview.png b/images/audio_track_overview.png
diff --git a/images/audiotool_com_top_bar.png b/images/audiotool_com_top_bar.png
diff --git a/images/audiotool_splash_screen.png b/images/audiotool_splash_screen.png
diff --git a/images/audiotrack.png b/images/audiotrack.png
diff --git a/images/autofilter1.png b/images/autofilter1.png
diff --git a/images/autofilter2.png b/images/autofilter2.png
diff --git a/images/bandsplitter.png b/images/bandsplitter.png
diff --git a/images/bassline.png b/images/bassline.png
diff --git a/images/bassline1.png b/images/bassline1.png
diff --git a/images/bassline2.png b/images/bassline2.png
diff --git a/images/bassline3.png b/images/bassline3.png
diff --git a/images/beat_eight.png b/images/beat_eight.png
diff --git a/images/beat_eight2.png b/images/beat_eight2.png
diff --git a/images/beat_eight3.png b/images/beat_eight3.png
diff --git a/images/beatbox2.png b/images/beatbox2.png
diff --git a/images/beatbox3.png b/images/beatbox3.png
diff --git a/images/beatbox91.png b/images/beatbox91.png
diff --git a/images/booster_connected.png b/images/booster_connected.png
diff --git a/images/centroid1.png b/images/centroid1.png
diff --git a/images/centroid2.png b/images/centroid2.png
diff --git a/images/centroid4.png b/images/centroid4.png
diff --git a/images/centroid5.png b/images/centroid5.png
diff --git a/images/centroid_insert_channel_righclick.png b/images/centroid_insert_channel_righclick.png
diff --git a/images/chorus.png b/images/chorus.png
diff --git a/images/compressor.png b/images/compressor.png
diff --git a/images/crossfader.png b/images/crossfader.png
diff --git a/images/crusher.png b/images/crusher.png
diff --git a/images/curve.png b/images/curve.png
diff --git a/images/delay.png b/images/delay.png
diff --git a/images/desktop.png b/images/desktop.png
diff --git a/images/drag-pulv-to-desktop.gif b/images/drag-pulv-to-desktop.gif
diff --git a/images/drag-sample-to-desktop.gif b/images/drag-sample-to-desktop.gif
diff --git a/images/eq1.png b/images/eq1.png
diff --git a/images/eq2.png b/images/eq2.png
diff --git a/images/eq_wave2.png b/images/eq_wave2.png
diff --git a/images/exciter.png b/images/exciter.png
diff --git a/images/exciter2.png b/images/exciter2.png
diff --git a/images/flanger.png b/images/flanger.png
diff --git a/images/gate.png b/images/gate.png
diff --git a/images/gravity.png b/images/gravity.png
diff --git a/images/hei1.png b/images/hei1.png
diff --git a/images/hei_env3.png b/images/hei_env3.png
diff --git a/images/hei_filter1.png b/images/hei_filter1.png
diff --git a/images/hei_lfo1.png b/images/hei_lfo1.png
diff --git a/images/hei_master2.png b/images/hei_master2.png
diff --git a/images/hei_operator2.png b/images/hei_operator2.png
diff --git a/images/hei_pitch_env2.png b/images/hei_pitch_env2.png
diff --git a/images/helmholtz.png b/images/helmholtz.png
diff --git a/images/kobolt.png b/images/kobolt.png
diff --git a/images/machiniste1.png b/images/machiniste1.png
diff --git a/images/machiniste3.png b/images/machiniste3.png
diff --git a/images/machiniste4.png b/images/machiniste4.png
diff --git a/images/machiniste5.png b/images/machiniste5.png
diff --git a/images/main-controls.png b/images/main-controls.png
diff --git a/images/matrix_arpeggiator.png b/images/matrix_arpeggiator.png
diff --git a/images/merger.png b/images/merger.png
diff --git a/images/minimixer+reverb.png b/images/minimixer+reverb.png
diff --git a/images/minimixer.png b/images/minimixer.png
diff --git a/images/mix/crossfader.webp b/images/mix/crossfader.webp
diff --git a/images/mix/cue_controls.webp b/images/mix/cue_controls.webp
diff --git a/images/mix/eq.webp b/images/mix/eq.webp
diff --git a/images/mix/jogweels.webp b/images/mix/jogweels.webp
diff --git a/images/mix/loop_sync_nudge.webp b/images/mix/loop_sync_nudge.webp
diff --git a/images/mix/menu_layout.webp b/images/mix/menu_layout.webp
diff --git a/images/mix/menu_midi_mapping.webp b/images/mix/menu_midi_mapping.webp
diff --git a/images/mix/menu_midi_mapping_open.webp b/images/mix/menu_midi_mapping_open.webp
diff --git a/images/mix/menu_output.webp b/images/mix/menu_output.webp
diff --git a/images/mix/menu_renderer.webp b/images/mix/menu_renderer.webp
diff --git a/images/mix/menu_themes.webp b/images/mix/menu_themes.webp
diff --git a/images/mix/mix.webp b/images/mix/mix.webp
diff --git a/images/mix/player_displays.webp b/images/mix/player_displays.webp
diff --git a/images/mix/tracklist_empty.webp b/images/mix/tracklist_empty.webp
diff --git a/images/mix/tracklist_local.webp b/images/mix/tracklist_local.webp
diff --git a/images/mix/tracklist_open.webp b/images/mix/tracklist_open.webp
diff --git a/images/mix/tracklist_seachresult.webp b/images/mix/tracklist_seachresult.webp
diff --git a/images/mix/trim_master.webp b/images/mix/trim_master.webp
diff --git a/images/notesplitter.png b/images/notesplitter.png
diff --git a/images/panel.png b/images/panel.png
diff --git a/images/panorama.png b/images/panorama.png
diff --git a/images/pdelay.png b/images/pdelay.png
diff --git a/images/peq.png b/images/peq.png
diff --git a/images/phaser.png b/images/phaser.png
diff --git a/images/placing-editing-notes.gif b/images/placing-editing-notes.gif
diff --git a/images/playback_speed_automation_0.png b/images/playback_speed_automation_0.png
diff --git a/images/playback_speed_automation_1.png b/images/playback_speed_automation_1.png
diff --git a/images/playback_speed_automation_2.png b/images/playback_speed_automation_2.png
diff --git a/images/publish-dialog.png b/images/publish-dialog.png
diff --git a/images/pulsar.png b/images/pulsar.png
diff --git a/images/pulverisateur1.png b/images/pulverisateur1.png
diff --git a/images/pulverisateur2.png b/images/pulverisateur2.png
diff --git a/images/pulverisateur3.png b/images/pulverisateur3.png
diff --git a/images/pulverisateur4.png b/images/pulverisateur4.png
diff --git a/images/pulverisateur5.png b/images/pulverisateur5.png
diff --git a/images/pulverisateur6.png b/images/pulverisateur6.png
diff --git a/images/pulverisateur7.png b/images/pulverisateur7.png
diff --git a/images/pulverisateur8.png b/images/pulverisateur8.png
diff --git a/images/pulverisateur9.png b/images/pulverisateur9.png
diff --git a/images/quantum.png b/images/quantum.png
diff --git a/images/rasselbock1.png b/images/rasselbock1.png
diff --git a/images/rasselbock2.png b/images/rasselbock2.png
diff --git a/images/rasselbock3.png b/images/rasselbock3.png
diff --git a/images/rasselbock4.png b/images/rasselbock4.png
diff --git a/images/reverb-diffuse.png b/images/reverb-diffuse.png
diff --git a/images/reverb-full.png b/images/reverb-full.png
diff --git a/images/reverb-input.png b/images/reverb-input.png
diff --git a/images/reverb-output.png b/images/reverb-output.png
diff --git a/images/reverb-plate.png b/images/reverb-plate.png
diff --git a/images/reverb-preview.png b/images/reverb-preview.png
diff --git a/images/reverb-vibrato.png b/images/reverb-vibrato.png
diff --git a/images/reverb.png b/images/reverb.png
diff --git a/images/ringmod.png b/images/ringmod.png
diff --git a/images/sample-in-panel.png b/images/sample-in-panel.png
diff --git a/images/sample-search.gif b/images/sample-search.gif
diff --git a/images/save-context.png b/images/save-context.png
diff --git a/images/save_project_dialogue.png b/images/save_project_dialogue.png
diff --git a/images/save_project_popup.png b/images/save_project_popup.png
diff --git a/images/set_playback_mode_to_timestretch.png b/images/set_playback_mode_to_timestretch.png
diff --git a/images/simple-completed-project.png b/images/simple-completed-project.png
diff --git a/images/slope.png b/images/slope.png
diff --git a/images/space/10000000000002AD000001D414A86BBBC483C1ED.png b/images/space/10000000000002AD000001D414A86BBBC483C1ED.png
diff --git a/images/space/10000000000002AD000001D4316FCC45D85FE40B.png b/images/space/10000000000002AD000001D4316FCC45D85FE40B.png
diff --git a/images/space/10000000000002AD000001D48CCB814FFB0B80E4.png b/images/space/10000000000002AD000001D48CCB814FFB0B80E4.png
diff --git a/images/space/10000201000002AD000001D40040919630530868.png b/images/space/10000201000002AD000001D40040919630530868.png
diff --git a/images/space/10000201000002AD000001D414102E31040957F1.png b/images/space/10000201000002AD000001D414102E31040957F1.png
diff --git a/images/space/10000201000002AD000001D446B039FDDDA0D4BE.png b/images/space/10000201000002AD000001D446B039FDDDA0D4BE.png
diff --git a/images/space/10000201000002AD000001D4502847CB8DF2D3F6.png b/images/space/10000201000002AD000001D4502847CB8DF2D3F6.png
diff --git a/images/space/10000201000002AD000001D454C30E7D7D7F1156.png b/images/space/10000201000002AD000001D454C30E7D7D7F1156.png
diff --git a/images/space/10000201000002AD000001D4579BD7C8DBC7C0E2.png b/images/space/10000201000002AD000001D4579BD7C8DBC7C0E2.png
diff --git a/images/space/10000201000002AD000001D457AB937843B94177.png b/images/space/10000201000002AD000001D457AB937843B94177.png
diff --git a/images/space/10000201000002AD000001D4822D7F5D54990B11.png b/images/space/10000201000002AD000001D4822D7F5D54990B11.png
diff --git a/images/space/10000201000002AD000001D4CBCF760D17EA3956.png b/images/space/10000201000002AD000001D4CBCF760D17EA3956.png
diff --git a/images/space/10000201000002AD000001D4D142ACEFA7E36E41.png b/images/space/10000201000002AD000001D4D142ACEFA7E36E41.png
diff --git a/images/space/10000201000002AD000001D4DEDE24071AC6426F.png b/images/space/10000201000002AD000001D4DEDE24071AC6426F.png
diff --git a/images/space/10000201000002AD000001D4DFA6DED4E3E20D51.png b/images/space/10000201000002AD000001D4DFA6DED4E3E20D51.png
diff --git a/images/space/10000201000002AD000001D4EC8FC6464E514B85.png b/images/space/10000201000002AD000001D4EC8FC6464E514B85.png
diff --git a/images/space/10000201000002AD000001D4ED7CCDA82CFBD8C8.png b/images/space/10000201000002AD000001D4ED7CCDA82CFBD8C8.png
diff --git a/images/splitter.png b/images/splitter.png
diff --git a/images/stereo2.png b/images/stereo2.png
diff --git a/images/stereodetune.png b/images/stereodetune.png
diff --git a/images/stereoenhancer.png b/images/stereoenhancer.png
diff --git a/images/three_audio_regions.png b/images/three_audio_regions.png
diff --git a/images/timeline.png b/images/timeline.png
diff --git a/images/tinygain.png b/images/tinygain.png
diff --git a/images/tonematrix01.png b/images/tonematrix01.png
diff --git a/images/tube.png b/images/tube.png
diff --git a/images/waveshaper.png b/images/waveshaper.png
diff --git 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 <https://www.audiotool.com>`_!
 
-.. _audiotool.com: https://www.audiotool.com
+If this is your first time, check out the :ref:`getting started <Your first project>` page or 
+watch the :ref:`first steps video series <Video Tutorials>`.
 
 
-Basics
-~~~~~~
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   manuals/basics/what_is_audiotool
-   manuals/basics/getting_started
-   manuals/basics/publish_track
 
 
 
+.. toctree::
+   :caption: Getting started
+   :maxdepth: 1
+   :glob:
 
-Editor
-~~~~~~
+   manuals/getting_started/what_is_audiotool
+   manuals/getting_started/your_first_project
+   manuals/getting_started/video_tutorials
 
 .. toctree::
+   :caption: Editor
    :maxdepth: 1
    :glob:
    :reversed:
 
    manuals/editor/*
 
-
-
-Drums
-~~~~~
+Plugins
+-------
 
 .. toctree::
+   :caption: Drums
    :maxdepth: 1
    :glob:
 
-   manuals/plugins/drums/*
+   manuals/plugins/drums/machiniste
+   manuals/plugins/drums/beatbox_8
+   manuals/plugins/drums/beatbox_9
 
-Synthesizer
-~~~~~~~~~~~
 .. toctree::
+   :caption: Synthesizer
    :maxdepth: 1
    :glob:
 
-   manuals/plugins/synthesizer/*
+   manuals/plugins/synthesizer/bassline
+   manuals/plugins/synthesizer/pulverisateur
+   manuals/plugins/synthesizer/heisenberg
+   manuals/plugins/synthesizer/tone_matrix
+   manuals/plugins/synthesizer/space
 
-Tools
-~~~~~
 .. toctree::
+   :caption: Tools
    :maxdepth: 1
    :glob:
 
-   manuals/plugins/tools/*
+   manuals/plugins/tools/audiotrack
+   manuals/plugins/tools/minimixer
+   manuals/plugins/tools/kobolt
+   manuals/plugins/tools/crossfader
+   manuals/plugins/tools/centroid
+   manuals/plugins/tools/bandsplitter
+   manuals/plugins/tools/splitter
+   manuals/plugins/tools/merger
+   manuals/plugins/tools/panorama
+   manuals/plugins/tools/tinygain
 
-Mastering
-~~~~~~~~~
 .. toctree::
+   :caption: Mastering
    :maxdepth: 1
    :glob:
 
-   manuals/plugins/mastering/*
+   manuals/plugins/mastering/quantum
+   manuals/plugins/mastering/curve
 
-Effects
-~~~~~~~
 .. toctree::
+   :caption: Effects
    :maxdepth: 1
    :glob:
 
-   manuals/plugins/effects/*
+   manuals/plugins/effects/chorus
+   manuals/plugins/effects/compressor
+   manuals/plugins/effects/crusher
+   manuals/plugins/effects/delay
+   manuals/plugins/effects/flanger
+   manuals/plugins/effects/gate_effect
+   manuals/plugins/effects/parametric_equaliser
+   manuals/plugins/effects/phaser
+   manuals/plugins/effects/pitch_delay
+   manuals/plugins/effects/reverb
+   manuals/plugins/effects/slope
+   manuals/plugins/effects/stereo_detune
+   manuals/plugins/effects/tube_distortion
+   manuals/plugins/effects/quasar
+   manuals/plugins/effects/rasselbock
+   manuals/plugins/effects/autofilter
+   manuals/plugins/effects/graphical_equalizer
+   manuals/plugins/effects/pulsar_delay
+   manuals/plugins/effects/waveshaper
+   manuals/plugins/effects/gravity
+   manuals/plugins/effects/helmholtz
+   manuals/plugins/effects/stereo_enhancer
+   manuals/plugins/effects/exciter
+   manuals/plugins/effects/ringmodulator
+
 
-Notes
-~~~~~
 .. toctree::
+   :caption: Note Processors
+   :name: notes
    :maxdepth: 1
    :glob:
 
-   manuals/plugins/notes/*
+   manuals/plugins/notes/matrix
+   manuals/plugins/notes/notesplitter
 
-Other
-~~~~~
 
 .. toctree::
+   :caption: More
    :maxdepth: 1
    :glob:
 
-   manuals/other/*
+   manuals/other/mix
+   manuals/other/performance_issues
+   manuals/other/contribute
+
+
+
+This website is a community effort -  `let us know <https://github.com/audiotool/manual/issues>`_ if you notice anything that could be improved,
+or head over to :ref:`how to contribute <Contribute>` to see how you can work on the documentation yourself!
diff --git a/manuals/basics/getting_started.md b/manuals/basics/getting_started.md
diff --git a/manuals/basics/publish_track.md b/manuals/basics/publish_track.md
diff --git a/manuals/basics/what_is_audiotool.md b/manuals/basics/what_is_audiotool.md
diff --git a/manuals/editor/advanced_audio_editing.md b/manuals/editor/advanced_audio_editing.md