Skip to content
Data and software for building the ACL Anthology.
Python HTML Makefile CSS Shell Perl TeX
Branch: master
Clone or download
Latest commit ac4d566 Jan 9, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.git-hooks Enforce code formatting and add check_commit/autofix targets (#669) Dec 9, 2019
.github
bin Added summary script (#711) Jan 8, 2020
data
google-cse Add configuration files for Google Custom Search Mar 15, 2019
hugo Attachments and corrections through 2019-12-18 (#706) Dec 20, 2019
test Enforce code formatting and add check_commit/autofix targets (#669) Dec 9, 2019
.gitignore new Makefile, copy static files from other directory May 21, 2019
.pre-commit-config.yaml Enforce code formatting and add check_commit/autofix targets (#669) Dec 9, 2019
.travis.yml Build PDF sitemap (#579) Oct 17, 2019
LICENSE moved license to top level May 14, 2019
Makefile Automatic and manual fixed-case for all-caps titles (#700) Dec 18, 2019
README.md Enforce code formatting and add check_commit/autofix targets (#669) Dec 9, 2019
README_detailed.md Enforce code formatting and add check_commit/autofix targets (#669) Dec 9, 2019

README.md

ACL Anthology

These are basic instructions on generating the ACL Anthology website as seen on https://aclweb.org/anthology/. The official home of this repository is https://github.com/acl-org/acl-anthology.

Generating the Anthology

Prerequisites

To build the Anthology website, you will need:

  • Python 3.7 or higher
  • Hugo 0.58.3 or higher (can be downloaded directly from their repo; the extended version is required!)
  • bibutils for creating non-BibTeX citation formats (not strictly required to build the website, but without them you need to invoke the build steps manually as laid out in the detailed README)
  • optional: If you install libyaml-dev and Cython before running make the first time, the libyaml C library will be used instead of a python implementation, speeding up the build.

Building and deployment with GitHub

There is a GitHub actions action performing deployment directly from GitHub. To use this, you need to define these variables in your repository settings (web interface: settings -> secrets):

  • PUBLISH_TARGET: rsync will push the anthology to this target (e.g. user@aclweb.org:anthology-static)
  • PUBLISH_SSH_KEY: the secret key in standard pem format for authentication (without a passphrase)
  • PUBLISH_ANTHOLOGYHOST: The host which will serve the anthology later on (e.g. https://www.aclweb.org)

GitHub will then automatically build and deploy the current master whenever the master branch changes.

Cloning

Clone the Anthology repo to your local machine:

$ git clone https://github.com/acl-org/acl-anthology

Generating

Provided you have correctly installed all requirements, building the website should be as simple running make from the directory to which you cloned the repo.

The fully generated website will be in build/anthology afterwards. If any errors occur during this step, you can consult the detailed README for more information on the individual steps performed to build the site. You can see the resulting website by launching a local webserver with make serve, which will serve it at http://localhost:8000.

Note that building the website is quite a resource-intensive process; particularly the last step, invoking Hugo, uses about 18~GB of system memory. Building the anthology takes about 10 minutes on a laptop with an SSD.

(Note: This does not mean you need this amount of RAM in your system; in fact, the website builds fine on a laptop with 8 GB of RAM. The system might temporarily slow down due to swapping, however. The figure of approx. 18 GB is the maximum RAM usage reported when running hugo --minify --stepAnalysis.)

The anthology can be viewed locally by running hugo server in the hugo/ directory. Note that it rebuilds the site and therefore takes about a minute to start.

Contributing

If you'd like to contribute to the ACL Anthology, please take a look at:

History

This repo was originally wing-nus/acl and has been transferred over to acl-org as of 5 June 2017.

License

The code for building the ACL Anthology is distributed under the Apache License, v2.0.

You can’t perform that action at this time.