Skip to content

Commit

Permalink
include building the html explanation in publisher/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mpacer committed Mar 7, 2018
1 parent 51ccd35 commit c99adcf
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions publisher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,29 @@ Building an individual paper is done by running build_paper.py on the paper dire

In order to ensure that the papers will appear in order with the correct page numbers, you need to build all of them at once. This is the distinction between running build_papers.py

## Structure of the website

In addition to the proceedings pdf, you will need to construct the html files needed to share the proceedings with the world.

The html pages are derived from a few different templates:

- the main landing page (index.html.tmpl)
- a header shared across the html pages (header.html.tmpl)
- pages for the individual articles (article.html.tmpl)
- a page for the information about the conference organisers (organization.html.tmpl)
- a page for the information about students receiving scholarships (students.html.tmpl)

The resulting html files will include:

- `index.html`
- a page for each article, named ``<article_author>.html`
- a `bib/`` directory, containing:
- a bibfile for each article, named `<article_author>.bib`
- a bibfile for the complete proceedings, named `proc-scipy-<year of proceedings>.bib`
- a `pdf/` directory, containing:
- a pdf for each article, named `<article_author>.pdf`
- a pdf for the complete proceedings, named `proceedings.pdf`

## Building the proceedings: Makefile

There are a few commands of use when publishing the proceedings.
Expand Down

0 comments on commit c99adcf

Please sign in to comment.