Final pr

README.md

@@ -1,3 +1,11 @@
+## LapsTrans 
+See full documentation: http://lapstrans.rtfd.io/
+
+### About
+LapsTrans is a research project by students from Heidelberg University, done in a practial work format with guidance of [Parallel and Distributed Systems Group of Heidelberg University](https://pvs.ifi.uni-heidelberg.de/home) and Dr.Prof. Artur Andrzejak.  
+Based on the paper ["Leveraging Language to Learn Program Abstractions and Search Heuristics" C. Wong, K. Ellis et al.](https://arxiv.org/abs/2106.11053), 
+and the original software project accessible at [authors' repository](https://github.com/ellisk42/ec), LapsTrans strives to exploit trained LAPS model to translate domain specific python code to LISP.
+
 ### Getting started
 #### Option 1
 First you will have to solve non-trivial task of deploying LAPS on your machine. For instructions refer to [Deploying LapsTrans to Ubuntu 20](</ec/lapstrans_extensions/docs/For developers/Deploying LapsTrans to Ubuntu 20.md>)

docs/requirements.txt

@@ -0,0 +1,7 @@
+# Defining the exact version will make sure things don't break
+sphinx==4.2.0
+sphinx_rtd_theme==1.0.0
+readthedocs-sphinx-search==0.1.1
+m2r2
+sphinx-book-theme
+sphinx-autoapi

docs/source/README.md

@@ -1,9 +1,15 @@
+## About
+
+LapsTrans is a research project by students from Heidelberg University, done in a practial work format with guidance of [Parallel and Distributed Systems Group of Heidelberg University](https://pvs.ifi.uni-heidelberg.de/home) and Dr.Prof. Artur Andrzejak.  
+Based on the paper ["Leveraging Language to Learn Program Abstractions and Search Heuristics" C. Wong, K. Ellis et al.](https://arxiv.org/abs/2106.11053), 
+and the original software project accessible at [authors' repository](https://github.com/ellisk42/ec), LapsTrans strives to exploit trained LAPS model to translate domain specific python code to LISP.
+
 ## Getting started
 
 ### How to - Start
 
 #### Option 1
-First you will have to solve non-trivial task of deploying LAPS on your machine. For instructions refer to [Deploying LapsTrans to Ubuntu 20](Deploying_LapsTrans_to_Ubuntu_20.md)
+First you will have to solve non-trivial task of deploying LAPS on your machine. For instructions refer to [Deploying LapsTrans to Ubuntu 20](https://lapstrans.readthedocs.io/en/latest/docs/For_developers/Deploying_LapsTrans_to_Ubuntu_20.html)
 
 #### Option 2
 Alternatively, if you have access to the Uni Heidelberg HPC, you can find deployed instance at `/home/container/lapstrans_home/LapsTrans`
@@ -18,6 +24,10 @@ To execute the translation script, navigate to the `ec/` directory, type in the
 ```
 python3.7 lapstrans_extensions/translate.py -i <Path to the file containing the function to translate> config lapstrans_extensions/config.ini
 ```
+for example
+```
+python3.7 lapstrans_extensions/translate.py -i lapstrans_extensions/f_file.py config lapstrans_extensions/config.ini
+```
 or 
 ```
 python3.7 lapstrans_extensions/translate.py --cli config lapstrans_extensions/config.ini
@@ -26,7 +36,7 @@ python3.7 lapstrans_extensions/translate.py --cli config lapstrans_extensions/co
 For interactive input of functions.
 
 The results will be written to `lapstrans_extensions/working_dir/translation.json`, but you could modify that path and more through command line options and/or config.ini file.
-For more instructions go to [Configuration](/ec/lapstrans_extensions/docs/Configuration.md)
+For more instructions go to [Configuration](https://lapstrans.readthedocs.io/en/latest/docs/Configuration.html)
 
 ### How to - Data generation
 
@@ -38,7 +48,7 @@ python3.7 lapstrans_extensions/generate_training_data.py -i <Path to the file co
 This generates both language data for LAPS, as well as solved task examples for the dreamcoder portion of it.
 
 The results will be written to `ec/data/list/<Output name>`, but you could modify that path and more through command line options and/or config.ini file.
-For more instructions go to [Configuration](/ec/lapstrans_extensions/docs/Configuration.md)
+For more instructions go to [Configuration](https://lapstrans.readthedocs.io/en/latest/docs/Configuration.html)
 
 ### Notes
 

docs/source/_build/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 801ab37e1044aef2e931a4c10e0175b3
+tags: 645f666f9bcd5a90fca523b33c5a78b7