From 1d5e69a5904b797a35585de90f94f3563742d1e6 Mon Sep 17 00:00:00 2001 From: Samuel Bronson Date: Thu, 19 Jan 2023 00:41:10 +0000 Subject: [PATCH 1/4] Add Gitpod config This avoids filling up my ~/.local/lib/pythonX.Y/site-packages with transitive dependencies. --- .gitpod.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .gitpod.yml diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 0000000000..96aa541a32 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,16 @@ +# This configuration file was automatically generated by Gitpod. +# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml) +# and commit this file to your remote git repository to share the goodness with others. + +# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart + +tasks: + - init: | + make install + make all + command: | + make serve + +additionalRepositories: + - url: https://github.com/grame-cncm/faust.git + checkoutLocation: faustdoc/faust From 450125870fd99f8aed9b3d70b24c677d1a018ba6 Mon Sep 17 00:00:00 2001 From: Samuel Bronson Date: Thu, 19 Jan 2023 05:31:37 +0000 Subject: [PATCH 2/4] Add missing steps to .gitpod.yml --- .gitpod.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.gitpod.yml b/.gitpod.yml index 96aa541a32..5916961049 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -5,7 +5,11 @@ # Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart tasks: - - init: | + - before: | + sudo apt-get update + sudo DEBIAN_FRONTEND=noninteractive apt-get -y install cmake flex + init: | + make -C faust install PREFIX=$HOME/.local make install make all command: | From 07cc8b4a129bc5f5209d6ef8d5f41f2384cf08a1 Mon Sep 17 00:00:00 2001 From: Samuel Bronson Date: Thu, 19 Jan 2023 05:38:06 +0000 Subject: [PATCH 3/4] Add some requirements to README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 64311517d2..491d76c2cb 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,12 @@ This repository is intended to build the documentation of the Faust environment, and to provide the corresponding examples. ### Prerequisites +- you must have make, "g++" (the GCC or Clang C++ driver), bison, and flex installed. - you must have python, pip and [mkdocs](https://www.mkdocs.org/) installed. - you must have the Faust source code installed. You can get it from [github](https://github.com/grame-cncm/faust). **Be sure to use a fresh cloned repository and to correcly install submodules with `git submodule update --init`**. The exact location can possibly be set in the make command using the `FAUSTDIR` environment variable. +- you must have Faust installed in PATH, too: it's used during the build. + [FIXME: does it need to be built in any particular way to get the right options in mkdocs/docs/manual/options.md? + Since that's checked in, this won't matter except when it actually needs to be updated.] - you must have openssl installed for base64 conversion. ### WARNING: adding new files From d07a7d405d01b403b88045b185a6776f3bc2738b Mon Sep 17 00:00:00 2001 From: Samuel Bronson Date: Thu, 19 Jan 2023 17:13:09 +0000 Subject: [PATCH 4/4] base.css: Don't leave huge blank space on mobile Note: don't forget to keep the copies in faustlibraries.git in sync! --- docs/css/base.css | 14 +++++++------- mkdocs/theme/css/base.css | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/css/base.css b/docs/css/base.css index 1ed2ed6282..3af07dd319 100644 --- a/docs/css/base.css +++ b/docs/css/base.css @@ -40,13 +40,6 @@ pre { width: 40%; } -.bs-sidebar { - overflow-y: auto; - max-height: 100%; - height: calc(100vh - 100px); - overflow-x: hidden; -} - blockquote{ padding-left: 20pt; font-weight: bold; @@ -378,6 +371,13 @@ h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .head } @media (min-width: 992px) { + .bs-sidebar { + overflow-y: auto; + max-height: 100%; + height: calc(100vh - 100px); + overflow-x: hidden; + } + .dropdown-menu { overflow-y: auto; max-height: calc(100vh - 3.5rem); diff --git a/mkdocs/theme/css/base.css b/mkdocs/theme/css/base.css index 1ed2ed6282..3af07dd319 100644 --- a/mkdocs/theme/css/base.css +++ b/mkdocs/theme/css/base.css @@ -40,13 +40,6 @@ pre { width: 40%; } -.bs-sidebar { - overflow-y: auto; - max-height: 100%; - height: calc(100vh - 100px); - overflow-x: hidden; -} - blockquote{ padding-left: 20pt; font-weight: bold; @@ -378,6 +371,13 @@ h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .head } @media (min-width: 992px) { + .bs-sidebar { + overflow-y: auto; + max-height: 100%; + height: calc(100vh - 100px); + overflow-x: hidden; + } + .dropdown-menu { overflow-y: auto; max-height: calc(100vh - 3.5rem);