diff --git a/.github/workflows/build.py b/.github/workflows/build.py index 608eafb..7ce260c 100755 --- a/.github/workflows/build.py +++ b/.github/workflows/build.py @@ -4,8 +4,6 @@ import subprocess from pathlib import Path -import boto3 - logging.basicConfig( format="[%(levelname)s %(asctime)s] %(message)s", level=logging.INFO @@ -26,21 +24,6 @@ def main(): _copy_sources_to_build_dir(SAMPLES_SOURCE_DIR) _copy_sources_to_build_dir(TESTS_DIR) _build() - if os.environ.get("GITHUB_REF") != "refs/heads/master": - logging.info("Not uploading PDFs...") - return - logging.info("Uploading PDFs...") - _upload_pdfs() - - -def _upload_pdfs(): - s3_client = boto3.client("s3") - for pdf in PDFS_DIR.glob("*.pdf"): - logging.info("Uploading '%s'", pdf) - with pdf.open(mode="rb") as pdf_stream: - s3_client.put_object( - Bucket="cam-thesis", Key=f"pdf/{pdf.name}", Body=pdf_stream - ) def _clean_build_dir(): diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e3e68b0..28deace 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -11,12 +11,9 @@ jobs: - name: Install Dependencies run: | sudo apt-get update - sudo apt-get install -y python3 python3-boto3 texlive texlive-latex-extra + sudo apt-get install -y python3 texlive texlive-latex-extra - name: Build - env: - AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} - AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} run: | python3 .github/workflows/build.py diff --git a/README.md b/README.md index b63b07c..ec16aba 100644 --- a/README.md +++ b/README.md @@ -22,21 +22,6 @@ Pro tip: you can use one of the samples in the [`Samples`](./Samples) directory. -## How will the thesis look like? - -Your thesis document will look something like this: - -> [Plain (PDF)](https://cam-thesis.s3-eu-west-1.amazonaws.com/pdf/thesis.pdf) - -If you use the _clean_ sample, which can be found in [`./Samples/clean`](Samples/clean), it will look like this: - -> [Sample Clean (PDF)](https://cam-thesis.s3-eu-west-1.amazonaws.com/pdf/clean.pdf) - -The template also supports DVI and PS formats. All three formats can be generated -with the provided `Makefile`. - - - ## Producing `PDF`, `DVI` and `PS` documents @@ -76,8 +61,7 @@ it is based). It also supports some custom options. -* `techreport`: formats the document as a technical report (here's - [a sample](https://cam-thesis.s3-eu-west-1.amazonaws.com/pdf/techreport.pdf)). +* `techreport`: formats the document as a technical report. Here is a list of formatting points in which the technical report differs from a normal thesis (see [guidelines](http://www.cl.cam.ac.uk/techreports/submission.html) for @@ -92,8 +76,7 @@ It also supports some custom options. * if the `hyperref` package is used, the option `pdfpagelabels=false` will be passed to it. -* `firstyr`: formats the document as a first-year report (here's - [a sample](https://cam-thesis.s3-eu-west-1.amazonaws.com/pdf/firstyr.pdf)). This option removes +* `firstyr`: formats the document as a first-year report. This option removes some unneeded elements and modifies the submission note. Here is a list of formatting points in which the first year report differs from a normal thesis: @@ -103,8 +86,7 @@ It also supports some custom options. * no declaration, * no acknowledgements. -* `secondyr`: formats the document as a second-year report (here's - [a sample](https://cam-thesis.s3-eu-west-1.amazonaws.com/pdf/secondyr.pdf)). Similarly to +* `secondyr`: formats the document as a second-year report. Similarly to `firstyr`, this style modifies the submission note and removes unneeded elements. Specially, an abstract is retained (as for this report, research is often in a more "stable" state). Here is a list of formatting points in which the second year @@ -151,8 +133,7 @@ It also supports some custom options. _Note_: the package `makeidx` is used to create the index. -* `backrefs`: Add back references in the References section (here's - [a sample](https://cam-thesis.s3-eu-west-1.amazonaws.com/pdf/backrefs.pdf)). In other words, for each reference, it adds the page(s) where it is cited. +* `backrefs`: Add back references in the References section. In other words, for each reference, it adds the page(s) where it is cited. _Note_: the package `backref` is used to create the back references.