From a721460c89635e1c33aca26ef5ea1012877092d7 Mon Sep 17 00:00:00 2001 From: Enoc Date: Sun, 11 Apr 2021 18:49:13 -0600 Subject: [PATCH] Update Elisp Documentation (27.2) - Change Elisp scraper to FileScraper - Add notes about how to obtain Elisp doc files --- assets/javascripts/templates/pages/about_tmpl.coffee | 2 +- docs/file-scrapers.md | 10 ++++++++++ lib/docs/scrapers/elisp.rb | 6 +++--- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/assets/javascripts/templates/pages/about_tmpl.coffee b/assets/javascripts/templates/pages/about_tmpl.coffee index 2c2f2393..d5a0957f 100644 --- a/assets/javascripts/templates/pages/about_tmpl.coffee +++ b/assets/javascripts/templates/pages/about_tmpl.coffee @@ -268,7 +268,7 @@ credits = [ 'https://raw.githubusercontent.com/elixir-lang/elixir/master/LICENSE' ], [ 'Elisp', - '1990-1996, 1998-2019 Free Software Foundation, Inc.', + '1990-1996, 1998-2021 Free Software Foundation, Inc.', 'GPLv3', 'https://www.gnu.org/licenses/gpl-3.0.html' ], [ diff --git a/docs/file-scrapers.md b/docs/file-scrapers.md index 7c96f7bc..ea5b5d8f 100644 --- a/docs/file-scrapers.md +++ b/docs/file-scrapers.md @@ -37,6 +37,16 @@ curl https://media.djangoproject.com/docs/django-docs-$VERSION-en.zip | \ bsdtar --extract --file - --directory=docs/django\~$VERSION/ ``` +## Elisp + +Go to https://www.gnu.org/software/emacs/manual/elisp.html, donwload the HTML tarball and extract its content in `/path/to/devdocs/docs/elisp` or run the following command: + +```sh +mkdir /path/to/devdocs/docs/elisp \ +&& curl curl https://www.gnu.org/software/emacs/manual/elisp.html_node.tar.gz | \ +tar --extract --gzip --strip-components=1 --directory=/path/to/devdocs/docs/elisp +``` + ## Erlang Go to https://www.erlang.org/downloads and download the HTML documentation file. diff --git a/lib/docs/scrapers/elisp.rb b/lib/docs/scrapers/elisp.rb index 70702945..767b9f82 100644 --- a/lib/docs/scrapers/elisp.rb +++ b/lib/docs/scrapers/elisp.rb @@ -1,7 +1,7 @@ module Docs - class Elisp < UrlScraper + class Elisp < FileScraper self.type = 'elisp' - self.release = '27.1' + self.release = '27.2' self.base_url= 'https://www.gnu.org/software/emacs/manual/html_node/elisp/' self.root_path = 'index.html' self.links = { @@ -57,7 +57,7 @@ module Docs end options[:attribution]= <<-HTML - Copyright © 1990-1996, 1998-2019 Free Software Foundation, Inc.
+ Copyright © 1990-1996, 1998-2021 Free Software Foundation, Inc.
Licensed under the GNU GPL license. HTML