Skip to content

Commit

Permalink
update doc with more examples and mixed prop
Browse files Browse the repository at this point in the history
  • Loading branch information
maxibor committed Jul 26, 2019
1 parent b59eb73 commit 78a5858
Show file tree
Hide file tree
Showing 10 changed files with 4,157 additions and 3,224 deletions.
23 changes: 23 additions & 0 deletions .readthedocs.yml
@@ -0,0 +1,23 @@
# .readthedocs.yml
# 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 docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py

# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml

# Optionally build your docs in additional formats such as PDF and ePub
formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.7
install:
- requirements: docs/requirements.txt
File renamed without changes.
44 changes: 0 additions & 44 deletions docs/add_new_sources.md

This file was deleted.

9 changes: 6 additions & 3 deletions docs/conf.py
Expand Up @@ -52,7 +52,9 @@
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
'sphinx.ext.napoleon'
'sphinx.ext.napoleon',
'nbsphinx',
'sphinx.ext.mathjax',
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -62,7 +64,7 @@
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ['.rst', '.md']
source_suffix = ['.rst', '.md', '.ipynb']

# The master toctree document.
master_doc = 'index'
Expand All @@ -77,7 +79,8 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ['_build', 'Thumbs.db',
'.DS_Store', '_build', '**.ipynb_checkpoints']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Expand Up @@ -23,6 +23,7 @@ __ homepage_
custom_sources
add_new_sources
run_example
mixed_prop


Indices and tables
Expand Down

0 comments on commit 78a5858

Please sign in to comment.