Merge pull request #167 from sdv-dev/tabular-models

Tabular models

.github/workflows/docs.yml

@@ -18,6 +18,7 @@ jobs:
 
     - name: Build
       run: |
+        sudo apt install pandoc
         python -m pip install --upgrade pip
         pip install -e .[dev]
         make docs

.github/workflows/tests.yml

@@ -24,12 +24,12 @@ jobs:
     - if: matrix.os == 'ubuntu-latest'
       name: Install graphviz - Ubuntu
       run: |
-        sudo apt-get install graphviz
+        sudo apt-get install graphviz pandoc
 
     - if: matrix.os == 'macos-latest'
       name: Install graphviz - MacOS
       run: |
-        brew install graphviz
+        brew install graphviz pandoc
 
     - name: Install dependencies
       run: |

.gitignore

@@ -106,3 +106,5 @@ ENV/
 .*.swp
 
 sdv/data/
+tutorials/sdv.pkl
+tutorials/demo_metadata.json

.travis.yml

@@ -9,7 +9,7 @@ python:
 # Command to install dependencies
 install:
   - sudo apt-get update
-  - sudo apt-get install graphviz
+  - sudo apt-get install graphviz pandoc
   - pip install -U tox-travis codecov
 
 after_success: codecov

Makefile

@@ -50,6 +50,7 @@ clean-pyc: ## remove Python file artifacts
 .PHONY: clean-docs
 clean-docs: ## remove previously built docs
 	rm -f docs/api/*.rst
+	rm -rf docs/tutorials
 	-$(MAKE) -C docs clean 2>/dev/null  # this fails if sphinx is not yet installed
 
 .PHONY: clean-coverage
@@ -110,7 +111,7 @@ test-readme: ## run the readme snippets
 
 .PHONY: test-tutorials
 test-tutorials: ## run the tutorial notebooks
-	jupyter nbconvert --execute --ExecutePreprocessor.timeout=600 examples/?.\ *.ipynb --stdout > /dev/null
+	jupyter nbconvert --execute --ExecutePreprocessor.timeout=600 tutorials/*.ipynb --stdout > /dev/null
 
 .PHONY: test
 test: test-unit test-readme test-tutorials ## test everything that needs test dependencies
@@ -134,6 +135,7 @@ coverage: ## check code coverage quickly with the default Python
 
 .PHONY: docs
 docs: clean-docs ## generate Sphinx HTML documentation, including API docs
+	cp -r tutorials docs/tutorials
 	sphinx-apidoc --separate --no-toc -o docs/api/ sdv
 	$(MAKE) -C docs html
 

docs/conf.py

@@ -32,6 +32,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'm2r',
+    'nbsphinx',
     'sphinx.ext.autodoc',
     'sphinx.ext.githubpages',
     'sphinx.ext.viewcode',
@@ -53,6 +54,9 @@
 # The master toctree document.
 master_doc = 'index'
 
+# Jupyter Notebooks
+nbsphinx_execute = 'never'
+
 # General information about the project.
 project = 'SDV'
 slug = 'sdv'

docs/index.rst

@@ -7,9 +7,11 @@
    Overview <readme>
 
 .. toctree::
-   :caption: Advanced Usage
-   :maxdepth: 3
+   :caption: User Guides
+   :maxdepth: 2
 
+   tutorials/02_Single_Table_Modeling
+   tutorials/03_Relational_Data_Modeling
    metadata
 
 .. toctree::

docs/metadata.rst

@@ -1,5 +1,5 @@
-Metadata
-========
+Working with Metadata
+=====================
 
 In order to use **SDV** you will need a ``Metadata`` object alongside your data.