Documentation makeover (#3)

* NEW: RTD documentation

* NEW: RTD documentation (1)

* NEW: RTD documentation (2)

* NEW: RTD documentation (3)

* NEW: RTD documentation (4)

* NEW: RTD documentation (5)

* NEW: RTD documentation (6)

* NEW: RTD documentation (7)

* NEW: RTD documentation (8)

* NEW: RTD documentation (9)

* NEW: RTD documentation (10)

* NEW: RTD documentation (11)

* NEW: RTD documentation (12)

* NEW: RTD documentation (13)

* NEW: RTD documentation (14)

* NEW: RTD documentation (15)

* NEW: RTD documentation (16)

* NEW: RTD documentation (17)

* NEW: RTD documentation (18)

* NEW: RTD documentation (19)

* NEW: RTD documentation (20)

* NEW: RTD documentation (21)

* NEW: RTD documentation (22)

* NEW: RTD documentation (23)

* NEW: RTD documentation (24)

* NEW: RTD documentation (25)

* NEW: RTD documentation (26)

* NEW: RTD documentation (26)

* NEW: RTD documentation (28)

* NEW: RTD documentation (29)

* NEW: RTD documentation (30)

* NEW: RTD documentation (31)

* NEW: RTD documentation (32)

* NEW: RTD documentation (33)

* NEW: RTD documentation (34)

* NEW: RTD documentation (35)

* NEW: RTD documentation (36)

* NEW: RTD documentation (37)

* NEW: RTD documentation (38)

* NEW: RTD documentation (39)

* NEW: RTD documentation (40)

* NEW: RTD documentation (41)

* ERF: Added MDP as a submodule

* NEW: RTD documentation (42)

* ERF: Added MDP as a submodule - make sure it is available for docs

* NEW: RTD documentation (43)

* NEW: RTD documentation (44)

* NEW: RTD documentation (45)

* NEW: RTD documentation (46)

* NEW: RTD documentation (47)

* NEW: RTD documentation (48)

* NEW: RTD documentation (49)

* NEW: RTD documentation (50)

* NEW: RTD documentation (51)

* NEW: RTD documentation (52)

* NEW: RTD documentation (53)

* NEW: RTD documentation (54)

* NEW: RTD documentation (55)

* NEW: RTD documentation (56)

* undo adding api docs because of warnings

* [legacy] ERF: added venv for building the legacy docs

* [legacy] ERF: removed venv for building the legacy docs

* [legacy] ERF: added old doc's sources

* removed accidental submodule

* [legacy] added legacy doc's sources

* [legacy] add built instructions and make mdp available

* [legacy] add built instructions rst -> md

* [legacy] add built instructions rst -> md

* [legacy] make favicon available

* [legacy] upgrade development.rst as in Stewori's PR

* [legacy] Adding Epydoc API doc files

* [legacy] added VartimeCovarianceMatrix to util descriptions

* [legacy] connect with new Epydoc API docs

* [legacy] fix dependency versions for future builds

* [legacy] update development.rst

* [legacy] update development.rst

* [legacy] minor typo in development.rst

* [legacy] straighten the make commands and automatically move the manually generated Epydoc API docs

* update submodule

* [legacy] minor makefile edit

* [legacy] update dependency versions to build node list

* [legacy] update guide to building

* [legacy] update announcement

* [legacy] update license to point to the online license file on GitHub

* [legacy] modernize installation instructions

* [legacy] include build

* [legacy] clean

* [legacy] clean

* [legacy] try gh-pages

* [legacy] clean

* [legacy] try ghpages

* [legacy] try ghpages

* [legacy] nojekyll gh pages

* [legacy] nojekyll gh pages

* [legacy] try gh pages

* [legacy] try gh pages

* [legacy] update makefile

* [legacy] update makefile

* [legacy] update additional_utilities.rst

* [legacy] adapt styling

* [legacy] undo accidental change to pdf

* [legacy] updat ghpages

* [legacy] update ghpages

* [legacy] fixed api toc

* [legacy] updated install.rst

* [legacy] update ghpages

* [legacy] minor changes to development.rst

* [legacy] update ghpages

* [legacy] minor changes to development.rst

* [legacy] update ghpages

* ERF: Reduce to legacy documentation

* ERF: Update website link

* ERF: Update website link

* ERF: Update website link

* FIX: gitignore

* ERF: Add description on how to handle failed tests

* ERF: Add description on how to handle failed tests

* ERF: Add description on how to handle failed tests

* ERF: Add description on how to handle failed tests

* ERF: update description on how to handle failing tests

Co-authored-by: Tiziano Zito <[email protected]>
Co-authored-by: Stefan Richthofer <[email protected]>

Author: 3 people

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "mdp-toolkit"]
+	path = mdp-toolkit
+	url = https://github.com/mdp-toolkit/mdp-toolkit

Makefile

@@ -181,3 +181,16 @@ codesnippet:
 	      "results in $(BUILDDIR)/codesnippet/."
 
 website: epydoc codesnippet html$(LINKS) latexpdf
+
+legacyapi:
+	mkdir -p $(BUILDDIR)/html
+	cp -a api $(BUILDDIR)/html/
+
+changeurl:
+	grep -rl $http://mdp-toolkit.sourceforge.net ./build/html \
+	| xargs sed -i \
+	s@$http://mdp-toolkit.sourceforge.net@$https://mdp-toolkit.github.io@g
+
+legacywebsite: legacyapi codesnippet html changeurl
+
+legacywebsitelocal: legacyapi codesnippet htmllocal

README.md

@@ -0,0 +1,16 @@
+### Please refer to the online documentation at https://mdp-toolkit.github.io/.
+
+### The source code is available at https://github.com/mdp-toolkit/mdp-toolkit.
+
+
+### How to built the legacy documentation:
+
+```bash
+python2.7 -m virtualenv /PATH/TO/VIRTUALENV/
+source /PATH/TO/VIRTUALENV/bin/activate
+pip install sphinx==1.6.4 epydoc==3.0.1 numpy==1.16.6 future==0.18.2 scikit-learn==0.20.4 pp==1.6.5 joblib==0.14.1
+# run the following in ./legacy to build a local version of the docs
+make legacywebsitelocal
+# run the following in ./legacy instead to build a version with weblinks
+make legacywebsite
+```