diff --git a/Makefile b/Makefile deleted file mode 100644 index 8ee23c1..0000000 --- a/Makefile +++ /dev/null @@ -1,16 +0,0 @@ -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SOURCEDIR = . -BUILDDIR = _build - - -all: html - -serve: html - http-server _build/html - -upload: html - rsync _build/html/ vcvrack.com:vcvrack.com/manual/ -ruvz --delete - -%: - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) diff --git a/_static/MyModule.svg b/_static/MyModule.svg deleted file mode 100644 index 89d5a31..0000000 --- a/_static/MyModule.svg +++ /dev/null @@ -1,229 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/_static/overrides.css b/_static/overrides.css deleted file mode 100644 index 7bc88c9..0000000 --- a/_static/overrides.css +++ /dev/null @@ -1,13 +0,0 @@ -@import url('https://cloud.typography.com/7479438/7888212/css/fonts.css'); - -body, h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend { - font-family: "Gotham Rounded A", "Gotham Rounded B", sans-serif; -} - -.wy-side-nav-search { - background-color: transparent; -} - -.wy-nav-content { - max-width: 1000px; -} diff --git a/_templates/layout.html b/_templates/layout.html deleted file mode 100644 index b59e2ee..0000000 --- a/_templates/layout.html +++ /dev/null @@ -1,12 +0,0 @@ -{% extends "!layout.html" %} - -{% block extrahead %}{{ super() }} - - -{% endblock %} \ No newline at end of file diff --git a/_templates/searchbox.html b/_templates/searchbox.html deleted file mode 100644 index e69de29..0000000 diff --git a/conf.py b/conf.py deleted file mode 100644 index c0bce61..0000000 --- a/conf.py +++ /dev/null @@ -1,105 +0,0 @@ - -project = 'VCV Rack' -copyright = '2020, VCV' -author = 'VCV' - -source_encoding = 'utf-8' - -extensions = [ - 'sphinx.ext.mathjax', - 'recommonmark', -] - -from recommonmark.parser import CommonMarkParser -from recommonmark.transform import AutoStructify - -source_parsers = { - '.md': CommonMarkParser, -} - -source_suffix = ['.rst', '.md'] - -templates_path = ['_templates'] - -master_doc = 'index' - -language = 'en' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path . -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - - -# Theme - -html_favicon = "favicon.png" - -html_theme = "sphinx_rtd_theme" - -html_theme_options = { - 'logo_only': True, # if we have a html_logo below, this shows /only/ the logo with no title text - 'collapse_navigation': False, # Collapse navigation (False makes it tree-like) -} - -html_context = { - "display_github": True, - "github_user": "VCVRack", - "github_repo": "manual", - "github_version": "master", - "conf_py_path": "/", -} - -html_logo = 'images/logo.png' - -html_static_path = ['_static'] - -html_show_sphinx = False -html_show_copyright = False - -htmlhelp_basename = 'VCVRackdoc' - - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -latex_documents = [ - (master_doc, 'VCVRack.tex', 'VCV Rack Manual Documentation', - 'VCV', 'manual'), -] - - -epub_title = project -epub_author = author -epub_publisher = author -epub_copyright = copyright -epub_exclude_files = ['search.html'] - - -def setup(app): - app.add_css_file("overrides.css") - app.add_config_value('recommonmark_config', { - 'enable_auto_toc_tree': True, - 'auto_toc_tree_section': "Table of Contents", - 'enable_math': True, - 'enable_inline_math': True, - }, True) - app.add_transform(AutoStructify) diff --git a/favicon.png b/favicon.png deleted file mode 100644 index caf0fa7..0000000 Binary files a/favicon.png and /dev/null differ diff --git a/index.md b/index.md new file mode 100644 index 0000000..056e727 --- /dev/null +++ b/index.md @@ -0,0 +1 @@ +[VCV Rack](https://vcvrack.com/) is an open-source modular synthesizer for Windows/Mac/Linux that simulates Eurorack modules. diff --git a/index.rst b/index.rst deleted file mode 100644 index 691b16c..0000000 --- a/index.rst +++ /dev/null @@ -1,52 +0,0 @@ - -VCV Rack Manual -=========================================== - -`VCV Rack `_ is an open-source virtual modular synthesizer. - -Edit this manual at https://github.com/VCVRack/manual. - -.. toctree:: - :maxdepth: 1 - :caption: Rack - - FAQ.md - Installing.md - GettingStarted.md - MenuBar.md - Core.md - Polyphony.md - KeyCommands.md - -.. toctree:: - :maxdepth: 1 - :caption: Plugin Development - - PluginDevelopmentTutorial.md - Panel.md - Manifest.md - VoltageStandards.md - DSP.md - Migrate1.md - PluginLicensing.md - -.. toctree:: - :maxdepth: 1 - :caption: Rack Development - - Building.md - Version.md - -.. toctree:: - :maxdepth: 1 - :caption: Appendix - - Issues.md - Communities.md - About.md - - -.. - This somehow triggers Mathjax to be loaded on all Markdown pages. -.. math:: - diff --git a/toc.md b/toc.md new file mode 100644 index 0000000..84bb9bc --- /dev/null +++ b/toc.md @@ -0,0 +1,27 @@ + +- Rack + - [FAQ](/FAQ) + - [Installing](/Installing) + - [Getting Started](/GettingStarted) + - [Menu Bar](/MenuBar) + - [Core](/Core) + - [Polyphony](/Polyphony) + - [Key Commands](/KeyCommands) + +- Plugin Development + - [Plugin Development Tutorial](/PluginDevelopmentTutorial) + - [Panel](/Panel) + - [Manifest](/Manifest) + - [Voltage Standards](/VoltageStandards) + - [DSP](/DSP) + - [Migrate v1](/Migrate1) + - [Plugin Licensing](/PluginLicensing) + +- Rack Development + - [Building](/Building) + - [Version](/Version) + +- Appendix + - [Issues](/Issues) + - [Communities](/Communities) + - [About](/About)