Merge pull request #232 from vissarion/docs_clean

Create volesti documentation structure
GeomScale · Jul 12, 2022 · 361f9e9 · 361f9e9
2 parents 0287c07 + bae9f84
commit 361f9e9
Show file tree

Hide file tree

Showing 39 changed files with 3,795 additions and 316 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,14 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.9"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-<p align="center"><img src="doc/logo/volesti_logo.jpg"></p>
+<p align="center"><img src="docs/logo/volesti_logo.jpg"></p>
 
 **VolEsti** is a `C++` library for volume approximation and sampling of convex bodies (*e.g.* polytopes) with an `R`  interface. For a limited `Python` interface we refer to package [dingo](https://github.com/GeomScale/dingo). **VolEsti** is part of the [GeomScale](https://geomscale.github.io) project.
 
@@ -22,8 +22,7 @@
 
 ### 📄 Documentation
 
-* [Using the R Interface](doc/r_interface.md)
-* [Using the C++ Interface](doc/cpp_interface.md)
+* [Package documentation](https://volesti.readthedocs.io)
 * [Wikipage with Tutorials and Demos](https://github.com/GeomScale/volesti/wiki)
 * [Tutorial given to PyData meetup](https://vissarion.github.io/tutorials/volesti_tutorial_pydata.html)
 * [Tutorial on (truncated) logconcave sampling (R and C++)](https://papachristoumarios.github.io/2020/07/21/Sampling-from-high-dimensional-truncated-log-concave-densities-with-volesti)

diff --git a/doc/cpp_interface.md b/doc/cpp_interface.md
diff --git a/doc/credits.md b/doc/credits.md
diff --git a/doc/publications.md b/doc/publications.md
diff --git a/doc/r_interface.md b/doc/r_interface.md