Skip to content

Commit

Permalink
Docs updated (#16)
Browse files Browse the repository at this point in the history
* use conda for building
* install ipywebrtc via pip/pypi
* plan was to use node, but building ipywebrtc on rtd gives a memory issue.
  • Loading branch information
maartenbreddels committed Aug 7, 2018
1 parent 3b0a492 commit 9d97f97
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 6 deletions.
22 changes: 22 additions & 0 deletions docs/environment.yml
@@ -0,0 +1,22 @@
name: ipywebrtc_docs
channels:
- conda-forge
- defaults
dependencies:
- jupyter_sphinx
- ipywidgets
- nbformat
- nbsphinx
- notebook>=4.2
- python=3.6
- sphinx>=1.4.6
- sphinx_rtd_theme
- tornado
- python-dateutil
- recommonmark
- traitlets
- ipywidgets
- nodejs
- pip
- pip:
- ipywebrtc
14 changes: 8 additions & 6 deletions docs/source/conf.py
Expand Up @@ -94,12 +94,12 @@
# a list of builtin themes.
#
html_theme = 'alabaster'
# try:
# import sphinx_rtd_theme
# html_theme = "sphinx_rtd_theme"
# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# except:
# print "rtd theme not found"
try:
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
except:
print "rtd theme not found"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down Expand Up @@ -168,3 +168,5 @@
author, 'ipywebrtc', 'One line description of project.',
'Miscellaneous'),
]

nbsphinx_allow_errors = True
4 changes: 4 additions & 0 deletions readthedocs.yml
@@ -0,0 +1,4 @@
conda:
file: docs/environment.yml
python:
version: 3

0 comments on commit 9d97f97

Please sign in to comment.