nox for docs (#166)

Author: clonker

deeptime/covariance/util/covar_c/CMakeLists.txt

@@ -2,3 +2,4 @@ project(covartools CXX)
 
 set(SRC covartools.hpp covartools.cpp)
 pybind11_add_module(${PROJECT_NAME} ${SRC})
+target_include_directories(${PROJECT_NAME} PUBLIC ${CMAKE_CURRENT_LIST_DIR}/include ${common_includes})

docs/requirements.txt

@@ -12,3 +12,4 @@ sphinx-gallery
 torch
 memory_profiler
 mdshare
+nbconvert

noxfile.py

@@ -27,6 +27,14 @@ def tests(session: nox.Session) -> None:
     session.run("pytest", '-vv', '--doctest-modules', '--durations=20', *cov_args, '--pyargs', "tests/", 'deeptime')
 
 
+@nox.session(reuse_venv=True)
+def make_docs(session: nox.Session) -> None:
+    session.install("-r", "tests/requirements.txt")
+    session.install("-r", "docs/requirements.txt")
+    session.chdir("docs")
+    session.run("sphinx-build", "-M", "html", "source", "build", "-t", "notebooks")
+
+
 @nox.session(reuse_venv=True)
 def build(session: nox.Session) -> None:
     session.install("build")