Add readthedocs support.

jackz314 · Apr 14, 2021 · 8c4a89c · 8c4a89c
1 parent ff6bc1b
commit 8c4a89c
Show file tree

Hide file tree

Showing 17 changed files with 79 additions and 40 deletions.
diff --git a/.gitignore b/.gitignore
@@ -74,7 +74,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+doc/_build/
 
 # PyBuilder
 .pybuilder/
@@ -142,4 +142,4 @@ dmypy.json
 # Cython debug symbols
 cython_debug/
 
-/docs/generated/
+/doc/generated/
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the doc/ directory with Sphinx
+sphinx:
+   configuration: doc/conf.py
+
+# Optionally build your doc in additional formats such as PDF
+#formats:
+#   - pdf
+
+# Optionally set the version of Python and requirements required to build your doc
+python:
+   version: 3.8
+   install:
+   - requirements: requirements_doc.txt
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# eeglabio
+# eeglabio [![Documentation Status](https://readthedocs.org/projects/eeglabio/badge/?version=latest)](https://eeglabio.readthedocs.io/en/latest/?badge=latest)
 
 I/O support for EEGLAB files in Python.
 

diff --git a/docs/Makefile → doc/Makefile b/docs/Makefile → doc/Makefile
diff --git a/doc/_static/.gitignore b/doc/_static/.gitignore
@@ -0,0 +1 @@
+generated/
diff --git a/docs/_templates/autosummary/class.rst → doc/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst → doc/_templates/autosummary/class.rst
diff --git a/docs/_templates/autosummary/function.rst → doc/_templates/autosummary/function.rst b/docs/_templates/autosummary/function.rst → doc/_templates/autosummary/function.rst
diff --git a/docs/api.rst → doc/api.rst b/docs/api.rst → doc/api.rst
diff --git a/docs/conf.py → doc/conf.py b/docs/conf.py → doc/conf.py
@@ -14,8 +14,16 @@
 import sys
 currdir = os.path.dirname(__file__)
 sys.path.append(os.path.abspath(os.path.join(currdir, '..')))
+sys.path.append(os.path.abspath('..'))
 
-import eeglabio
+version = None
+with open(os.path.join(currdir, '..', 'eeglabio', '_version.py'), 'r') as fid:
+    for line in (line.strip() for line in fid):
+        if line.startswith('__version__'):
+            version = line.split('=')[1].strip().strip("'")
+            break
+if version is None:
+    version = "0.0.1"
 
 # -- Project information -----------------------------------------------------
 
@@ -24,7 +32,7 @@
 author = 'Jack Zhang'
 
 # The full version, including alpha/beta/rc tags
-release = eeglabio.__version__
+release = version
 
 
 # -- General configuration ---------------------------------------------------
@@ -76,3 +84,6 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+
+print(currdir)
+print(sys.path)
diff --git a/docs/epochs.rst → doc/epochs.rst b/docs/epochs.rst → doc/epochs.rst
diff --git a/docs/examples.rst → doc/examples.rst b/docs/examples.rst → doc/examples.rst
diff --git a/docs/index.rst → doc/index.rst b/docs/index.rst → doc/index.rst
diff --git a/docs/install.rst → doc/install.rst b/docs/install.rst → doc/install.rst
diff --git a/docs/make.bat → doc/make.bat b/docs/make.bat → doc/make.bat
@@ -1,35 +1,35 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/raw.rst → doc/raw.rst b/docs/raw.rst → doc/raw.rst
diff --git a/docs/utils.rst → doc/utils.rst b/docs/utils.rst → doc/utils.rst
diff --git a/requirements_doc.txt b/requirements_doc.txt
@@ -0,0 +1,7 @@
+sphinx==3.5.4
+numpydoc==1.1.0
+pydata-sphinx-theme==0.6.0
+sphinx_copybutton
+# readthedocs don't work without these
+numpy
+scipy