Remove ruby dependency from website build

Makefile.am

@@ -136,8 +136,8 @@ TESTS_ENVIRONMENT = NO_VALGRIND=$(NO_VALGRIND)
 
 man_MANS = jq.1
 if ENABLE_DOCS
-jq.1: $(srcdir)/docs/content/3.manual/manual.yml
-	$(AM_V_GEN) ( cd ${abs_srcdir}/docs; '$(BUNDLER)' exec rake manpage ) > $@ || { rm -f $@; false; }
+jq.1: $(srcdir)/docs/content/manual/manual.yml
+	$(AM_V_GEN) ( cd ${abs_srcdir}/docs; pipenv run python build_manpage.py ) > $@ || { rm -f $@; false; }
 jq.1.prebuilt: jq.1
 	$(AM_V_GEN) cp jq.1 $@ || { rm -f $@; false; }
 else
@@ -165,8 +165,8 @@ install-binaries: $(BUILT_SOURCES)
 	$(MAKE) $(AM_MAKEFLAGS) install-exec
 
 DOC_FILES = docs/content docs/public docs/templates docs/site.yml       \
-        docs/Gemfile docs/Gemfile.lock docs/Rakefile docs/README.md     \
-        jq.1.prebuilt
+        docs/Pipfile docs/Pipfile.lock docs/build_website.py            \
+        docs/README.md jq.1.prebuilt
 
 EXTRA_DIST = $(DOC_FILES) $(man_MANS) $(TESTS) $(TEST_LOG_COMPILER)     \
         jq.1.prebuilt jq.spec src/lexer.c src/lexer.h src/parser.c      \
@@ -180,11 +180,11 @@ EXTRA_DIST = $(DOC_FILES) $(man_MANS) $(TESTS) $(TEST_LOG_COMPILER)     \
         tests/modules/test_bind_order0.jq                               \
         tests/modules/test_bind_order1.jq                               \
         tests/modules/test_bind_order2.jq tests/onig.supp               \
-        tests/onig.test tests/setup tests/torture/input0.json		\
-        tests/optional.test tests/optionaltest				\
-	tests/utf8-truncate.jq tests/utf8test				\
-	tests/base64.test tests/base64test 				\
-	tests/jq-f-test.sh tests/shtest
+        tests/onig.test tests/setup tests/torture/input0.json           \
+        tests/optional.test tests/optionaltest                          \
+        tests/utf8-truncate.jq tests/utf8test                           \
+        tests/base64.test tests/base64test                              \
+        tests/jq-f-test.sh tests/shtest
 
 
 

configure.ac

@@ -74,7 +74,7 @@ dnl Code coverage
 AC_ARG_ENABLE([gcov],
    AC_HELP_STRING([--enable-gcov], [enable gcov code coverage tool]))
 
-dnl Don't attempt to build docs if there's no Ruby lying around
+dnl Don't attempt to build docs if python deps aren't installed
 AC_ARG_ENABLE([docs],
    AC_HELP_STRING([--disable-docs], [don't build docs]))
 
@@ -87,25 +87,25 @@ AC_ARG_ENABLE([all-static],
    AC_HELP_STRING([--enable-all-static], [link jq with static libraries only]))
 
 AS_IF([test "x$enable_docs" != "xno"],[
-   AC_CHECK_PROGS(bundle_cmd, bundle)
+   AC_CHECK_PROGS(pipenv_cmd, pipenv)
 
-   AC_CACHE_CHECK([for Ruby dependencies], [jq_cv_ruby_deps],
-     [jq_cv_ruby_deps=yes;
-        AS_IF([test "x$bundle_cmd" = "x" || \
-        ! bmsg="`cd ${srcdir}/docs; "$bundle_cmd" check 2>/dev/null`"],[
-           AC_MSG_WARN([$bmsg])
+   AC_CACHE_CHECK([for Python dependencies], [jq_cv_python_deps],
+     [jq_cv_python_deps=yes;
+        AS_IF([test "x$pipenv_cmd" = "x" || \
+        ! bmsg="`cd ${srcdir}/docs; LC_ALL=$LANG "$pipenv_cmd" check`"],[
+           AC_MSG_ERROR([$bmsg])
            cat <<EOF
 *****************************************************************
-*  Ruby dependencies for building jq documentation not found.   *
+*  Python dependencies for building jq documentation not found. *
 *  You can still build, install and hack on jq, but the manpage *
 *  will not be rebuilt and some of the tests will not run.      *
 *  See docs/README.md for how to install the docs dependencies. *
 *****************************************************************
 EOF
-           jq_cv_ruby_deps=no
+           jq_cv_python_deps=no
      ])])
 
-   if test "x$jq_cv_ruby_deps" != "xyes"; then
+   if test "x$jq_cv_python_deps" != "xyes"; then
      enable_docs=no
    fi
 ])

docs/.gitignore

@@ -1,6 +1,3 @@
 .DS_Store
 .sass-cache
 output/*
-
-# Autogenerated from public/css/base.scss
-public/css/base.css

docs/Pipfile

@@ -0,0 +1,11 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+
+[packages]
+jinja2 = "*"
+pyyaml = "*"
+markdown = "*"

docs/README.md

@@ -2,24 +2,19 @@ Documentation
 =============
 
 The jq website, manpages and some of the tests are generated from this
-directory. The directory holds a [Bonsai](http://tinytree.info)
-website, and the manual is a YAML file in `content/3.manual`.
+directory. The manual is a YAML file in `content/manual`.
 
 To build the documentation (including building the jq manpage), you'll
-need a working Ruby setup. The easiest way to get one is to install
-RVM and Ruby 1.9.3 like so:
+need python3 and pipenv. You can install pipenv like so:
 
-    \curl -L https://get.rvm.io | bash -s stable --ruby=1.9.3
+    pip install pipenv
 
-After that finishes installing, you'll need to make sure RVM is on
-your path by doing `source $HOME/.rvm/scripts/rvm`, or just opening a
-new shell. See <https://rvm.io> for more info on RVM.
+Though, you may need to say pip3 instead, depending on your system. Once
+you have pipenv installed, you can install the dependencies by running
+`pipenv install` from the `docs` directory.
 
-Once RVM is installed, you can install all the dependencies for jq's
-documentation build by running this from the `docs` directory:
+Once this is done, rerun `./configure` in the jq root directory and then
+the Makefile will be able to generate the jq manpage.
 
-    bundle install
-
-When bundle manages to install the dependencies, rerun `./configure`
-in the jq root directory and then the Makefile will be able to
-generate the jq manpage.
+To build the website, run `pipenv run ./build_website.py` from inside
+the `docs` directory.

docs/build_manpage.py

@@ -0,0 +1,2 @@
+#!/usr/bin/env python3
+print("Manpage build not yet supported")

docs/build_website.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+import glob
+import itertools
+from jinja2 import Environment, FileSystemLoader, Markup, select_autoescape, contextfunction
+from markdown import markdown
+import os
+import os.path
+import re
+import shutil
+import yaml
+
+env = Environment(
+  loader=FileSystemLoader('templates'),
+  autoescape=select_autoescape(['html.j2']),
+)
+
+def load_yml_file(fn):
+  with open(fn) as f:
+    return yaml.load(f)
+
+env.filters['search_id'] = lambda input: input.replace(r'`', '')
+env.filters['section_id'] = lambda input: re.sub(r"[^a-zA-Z0-9_]", '', input)
+env.filters['entry_id'] = lambda input: re.sub(r"[ `]", '', input)
+env.filters['markdownify'] = lambda input: Markup(markdown(input))
+env.filters['no_paragraph'] = lambda input: Markup(re.sub(r"</?p>", '', input))
+
+env.globals['unique_id'] = contextfunction(lambda ctx: str(next(ctx['unique_ctr'])))
+
+
+env.globals.update(load_yml_file('site.yml'))
+
+
+env.globals['navigation'] = ['tutorial', 'download', 'manual']
+
+def generate_file(env, fname='content/1.tutorial/default.yml'):
+  path, base = os.path.split(fname)
+  path = os.path.relpath(path, 'content')
+  output_dir = os.path.join('output', path)
+  output_path = os.path.join(output_dir, 'index.html')
+
+  template_name = re.sub(r".yml$", '.html.j2', base)
+
+  ctx = load_yml_file(fname)
+  ctx.update(unique_ctr=itertools.count(1), permalink=path)
+  os.makedirs(output_dir, exist_ok=True)
+  env.get_template(template_name).stream(ctx).dump(output_path, encoding='utf-8')
+
+
+def copy_public_files(root=''):
+  for f in os.scandir(os.path.join('public', root)):
+    src = os.path.join(root, f.name)
+    dst = os.path.join('output', src)
+    if f.is_dir():
+      os.makedirs(dst, exist_ok=True)
+      copy_public_files(src)
+    else:
+      shutil.copyfile(f.path, dst)
+
+copy_public_files()
+
+for fn in glob.glob('content/**/*.yml', recursive=True):
+  generate_file(env, fn)

docs/content/2.download/default.yml → docs/content/download/default.yml

@@ -180,14 +180,13 @@ body:
 
       #### Building the documentation
 
-      jq's documentation is compiled into static HTML using
-      [Bonsai](http://www.tinytree.info).  To view the documentation
-      locally, run `rake serve` (or `bundle exec rake serve`) from the
-      docs/ subdirectory.  To build the docs just `rake build` from the
-      docs subdirectory.  You'll need a few Ruby dependencies, which can
-      be installed by following the instructions in `docs/README.md`.
+      jq's documentation is compiled into static HTML using Python.
+      To build the docs, run `pipenv run python3 build_website.py` from
+      the docs/ subdirectory. To serve them locally, you can run
+      `python3 -m SimpleHTTPServer`. You'll need a few Python dependencies,
+      which can be installed by following the instructions in `docs/README.md`.
 
       The man page is built by `make jq.1`, or just `make`, also from
-      the YAML docs, and you'll still need the Ruby dependencies to
+      the YAML docs, and you'll still need the Python dependencies to
       build the manpage.
 

docs/content/3.manual/manual.yml → docs/content/manual/manual.yml

@@ -2230,6 +2230,7 @@ sections:
           STRING | FILTER( [REGEX, FLAGS] )
 
       where:
+
       * STRING, REGEX and FLAGS are jq strings and subject to jq string interpolation;
       * REGEX, after string interpolation, should be a valid PCRE regex;
       * FILTER is one of `test`, `match`, or `capture`, as described below.