Add links to lecture2notes paper

HHousen · Aug 13, 2021 · 1a7f899 · 1a7f899
1 parent 6a790e3
commit 1a7f899
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -4,9 +4,9 @@
 
 [![GitHub license](https://img.shields.io/github/license/HHousen/lecture2notes.svg)](https://github.com/HHousen/lecture2notes/blob/master/LICENSE) [![Github commits](https://img.shields.io/github/last-commit/HHousen/lecture2notes.svg)](https://github.com/HHousen/lecture2notes/commits/master) [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![Documentation Status](https://readthedocs.org/projects/lecture2notes/badge/?version=latest)](https://lecture2notes.readthedocs.io/en/latest/?badge=latest) [![GitHub issues](https://img.shields.io/github/issues/HHousen/lecture2notes.svg)](https://GitHub.com/HHousen/lecture2notes/issues/) [![GitHub pull-requests](https://img.shields.io/github/issues-pr/HHousen/lecture2notes.svg)](https://GitHub.com/HHousen/lecture2notes/pull/) [![DeepSource](https://static.deepsource.io/deepsource-badge-light-mini.svg)](https://deepsource.io/gh/HHousen/lecture2notes/?ref=repository-badge)
 
-**[Research Paper]()** / **[Documentation](https://lecture2notes.readthedocs.io/en/latest)** / **[Project Page](https://haydenhousen.com/projects/lecture2notes/)**
+**[Research Paper](https://haydenhousen.com/media/lecture2notes-paper-v1.pdf)** / **[Documentation](https://lecture2notes.readthedocs.io/en/latest)** / **[Project Page](https://haydenhousen.com/projects/lecture2notes/)**
 
-**Lecture2Notes** is a project that **summarizes lectures videos**. At a high level, it parses both the **visual** and **auditory** components of the video, **extracts text** from each, **combines** them, and then **summarizes** the combined text using **automatic** summarization algorithms. These pages document the code for the entirety of "[Lecture2Notes: Summarizing Lecture Videos by Classifying Slides and Analyzing Text using Machine Learning]()."
+**Lecture2Notes** is a project that **summarizes lectures videos**. At a high level, it parses both the **visual** and **auditory** components of the video, **extracts text** from each, **combines** them, and then **summarizes** the combined text using **automatic** summarization algorithms. These pages document the code for the entirety of "[Lecture2Notes: Summarizing Lecture Videos by Classifying Slides and Analyzing Text using Machine Learning](https://haydenhousen.com/media/lecture2notes-paper-v1.pdf)."
 
 **Check out [the documentation](https://lecture2notes.readthedocs.io/en/latest) for usage details.**
 

diff --git a/doc/getting-started/about.rst b/doc/getting-started/about.rst
@@ -4,7 +4,7 @@ About
 Overview
 --------
 
-**Lecture2Notes** is a project that **summarizes lectures videos**. At a high level, it parses both the **visual** and **auditory** components of the video, **extracts text** from each, **combines** them, and then **summarizes** the combined text using **automatic** summarization algorithms. These pages document the code for the entirety of "Lecture2Notes: Summarizing Lecture Videos by Classifying Slides and Analyzing Text using Machine Learning."
+**Lecture2Notes** is a project that **summarizes lectures videos**. At a high level, it parses both the **visual** and **auditory** components of the video, **extracts text** from each, **combines** them, and then **summarizes** the combined text using **automatic** summarization algorithms. These pages document the code for the entirety of "`Lecture2Notes: Summarizing Lecture Videos by Classifying Slides and Analyzing Text using Machine Learning <https://haydenhousen.com/media/lecture2notes-paper-v1.pdf>`__."
 
 **To get started**, visit :ref:`the tutorial <tutorial_general_summarize>`.
 

diff --git a/doc/getting-started/install.rst b/doc/getting-started/install.rst
@@ -8,6 +8,8 @@ Overview
 
 Installation is made easy due to conda environments. Simply run ``conda env create -f environment.yml`` from the root project directory and conda will create an environment called ``lecture2notes`` with all the required packages from ``environment.yml``.
 
+..note:: Read `the paper <https://haydenhousen.com/media/lecture2notes-paper-v1.pdf>`__ for more in-depth explanations regarding the background, methodology, and results of this project.
+
 Info About Optional Components
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/doc/getting-started/tutorial.rst b/doc/getting-started/tutorial.rst
@@ -3,6 +3,8 @@ Tutorial
 
 After you've installed lecture2notes using the instructions in :ref:`install`, you can follow this guide to perform some common actions.
 
+..note:: Read `the paper <https://haydenhousen.com/media/lecture2notes-paper-v1.pdf>`__ for more in-depth explanations regarding the background, methodology, and results of this project.
+
 .. _tutorial_general_summarize:
 
 Summarizing a lecture video