nox for docs (#166)

deeptime-ml · Nov 12, 2021 · a99fafb · a99fafb
1 parent a5d72f0
commit a99fafb
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/deeptime/covariance/util/covar_c/CMakeLists.txt b/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})
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -12,3 +12,4 @@ sphinx-gallery
 torch
 memory_profiler
 mdshare
+nbconvert
diff --git a/noxfile.py b/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")
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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})
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,3 +12,4 @@ sphinx-gallery @@
     torch
     memory_profiler
     mdshare
+    nbconvert