[WIP] Website

.gitignore

@@ -60,7 +60,7 @@ cmake_install.cmake
 install_manifest.txt
 compile_commands.json
 CTestTestfile.cmake
-build
+#build
 
 ### JupyterNotebook ###
 .ipynb_checkpoints
@@ -305,7 +305,7 @@ __pycache__/
 
 # Distribution / packaging
 .Python
-build/
+#build/
 develop-eggs/
 dist/
 downloads/
@@ -355,7 +355,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+#docs/_build/
 
 # PyBuilder
 target/

docs/index.html

@@ -0,0 +1 @@
+<meta http-equiv="refresh" content="0; url=./sphinx/build/html/index.html" />

docs/sphinx/README.md

@@ -0,0 +1,26 @@
+The following are needed for the documentation set-up:
+
+- conda install sphinx
+- conda install sphinxcontrib-bibtex
+- conda install sphinx-book-theme
+
+(See e.g. https://sphinx-themes.org/ for other choices of themes)
+
+
+From within the sphinx directory:
+
+- sphinx-build -b html source build
+- or 'make html'
+
+
+Then 'open build/html/index.html' will open the webpage.
+
+
+Important files:
+
+- sphinx/source/conf.py configures the set-up.  The project name, authors, version as well as extensions and project theme can all be changed here.
+- sphinx/source/index.rst is the 'front page', and table of contents etc are specified here
+- sphinx/source/simunet_analysis.rst contains some first basic examples of how we can generate documentation directly from the code docstrings.
+
+
+See also https://www.sphinx-doc.org/en/master/index.html for much more info on Sphinx

docs/sphinx/build/html/.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: 81a4d505685fc20ab270645bf4144170
+tags: 645f666f9bcd5a90fca523b33c5a78b7