Fix doc buildsystem

.gitignore

@@ -1,67 +1,55 @@
-# git ignore patterns
 
-libltdl/
-
-pynest/pynestkernel.cpp
+__pycache__/
+build/
+install/
+reports/
 
-*.o
-*.lo
+# compilation artefacts
+pynest/pynestkernel.cxx
 *.la
-.*
+*.lo
 *.log
+*.o
 *.pyc
-
-Makefile
-!/doc/Makefile
-
-build/
-install/
-
-/juqueen/
-/extras/nest-config
-/extras/create_release.sh
-/libnestutil/config.h
+*.so
 /librandom/randomtest
-/libtool
 /nest/nest
-/nest/static_modules.h
-/pynest/setup.py
-/reports/
 /sli/sli
-/testsuite/do_tests.sh
-/doc/doxygen/
-/doc/_build/
-/doc/xml/
-/doc/auto_examples/
 
-*.kdev4
-
-### IPythonNotebook ###
-# Temporary data
-.ipynb_checkpoints/
-TAGS
-
-### tags and cscope
-tags
-cscope.out
-
-### CMAKE stuff
-cmake_install.cmake
-CMakeFiles/
-_CPack_Packages/
+# cmake artefacts
 CMakeCache.txt
-CPackConfig.cmake
-CPackSourceConfig.cmake
+CMakeDoxyfile.in
+CMakeFiles/
+CTestTestfile.cmake
+Makefile
+cmake_install.cmake
+CMakeDoxygenDefaults.cmake
 
 # generated files
-doc/set_rcsinfo.cmake
 doc/fulldoc.conf
 doc/normaldoc.conf
+extras/nest-config
+extras/nest_vars.sh
+libnestutil/config.h
+nest/static_modules.h
+pynest/setup.py
+
+# installation artefacts
+install_manifest.txt
+
+# documentation artefacts
+doc/help/
+doc/auto_examples/
+doc/doctrees/
+doc/html/
 doc/models/
 doc/pynestkernel_mock.py
-doc/from_cpp/
-doc/microcircuit/
-lib/sli/rcsinfo.sli
-extras/nest_vars.sh
+examples/microcircuit.png
+examples/reference_data/
 
-pynest/examples/README
+# IDEs / editors / Jupyter
+*.kdev4
+.ipynb_checkpoints/
+TAGS
+tags
+cscope.out

.readthedocs.yml

@@ -0,0 +1,11 @@
+version: 2
+
+sphinx:
+  builder: html
+  configuration: doc/userdoc/conf.py
+
+conda:
+  environment: doc/environment.yml
+
+build:
+  image: latest

doc/CMakeLists.txt

@@ -59,9 +59,6 @@ endif ()
 install( DIRECTORY model_details
     DESTINATION ${CMAKE_INSTALL_DOCDIR} )
 
-install( FILES index.html doc_header.txt
-    DESTINATION ${CMAKE_INSTALL_DOCDIR} )
-
 if ( DOXYGEN_FOUND )
   add_custom_target( doc
       COMMAND ${DOXYGEN_EXECUTABLE} "${CMAKE_CURRENT_BINARY_DIR}/normaldoc.conf"
@@ -86,3 +83,17 @@ else ()
       COMMAND ${CMAKE_COMMAND} -E echo "Doxygen is not found on your system. Cannot build full documentation."
       )
 endif ()
+
+set( DOC_BUILD_DIR "${PROJECT_BINARY_DIR}/doc" )
+
+add_custom_target( html 
+  COMMAND [ "${PROJECT_SOURCE_DIR}" != "${PROJECT_BINARY_DIR}" ] && cp -r userdoc "${DOC_BUILD_DIR}" || true
+  COMMAND PYTHONDONTWRITEBYTECODE=1 sphinx-build -b html -c "${PROJECT_SOURCE_DIR}/doc" "${DOC_BUILD_DIR}/userdoc" "${DOC_BUILD_DIR}/userdoc/html"
+  COMMAND cp "${DOC_BUILD_DIR}/userdoc/models/*.rst" "${DOC_BUILD_DIR}/userdoc/html/models"
+  WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}/doc"
+)
+
+install( DIRECTORY "${DOC_BUILD_DIR}/userdoc/html"
+  DESTINATION "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DOCDIR}"
+  OPTIONAL
+)