Skip to content

Commit

Permalink
Fix for read the docs not building (#49)
Browse files Browse the repository at this point in the history
* Clean up tox.ini

* Remove morph submodule due to failing build

* Use Blue Brain theme

* Pin sphinx due to error in 3.0.0 on readthedocs

* Use theme copyright notice
  • Loading branch information
haleepfl committed Apr 7, 2020
1 parent f20ebe3 commit 7cdf9e3
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 8 deletions.
1 change: 0 additions & 1 deletion doc/source/circuits.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,4 @@ Circuits
circuit
config
edges
morph
nodes
3 changes: 1 addition & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@

project = 'Blue Brain SNAP'
author = 'Blue Brain Project, EPFL'
copyright = "Blue Brain Project/EPFL 2005-2020. All rights reserved"

release = get_distribution('bluepysnap').version
version = release
Expand Down Expand Up @@ -40,7 +39,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'
html_theme = 'sphinx-bluebrain-theme'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def __init__(self, *args, **kwargs):
'pathlib2>=2.3',
],
extras_require={
'docs': ['sphinx', 'sphinx_rtd_theme'],
'docs': ['sphinx<3.0.0', 'sphinx-bluebrain-theme'],
},
packages=find_packages(),
use_scm_version=True,
Expand Down
6 changes: 2 additions & 4 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,9 @@ commands =
pylint -j4 {[base]name}

[testenv:docs]
basepython=python3.6
basepython = python3.6
changedir = doc
deps =
sphinx
sphinx_rtd_theme
extras = docs
commands =
make clean
make html SPHINXOPTS=-W
Expand Down

0 comments on commit 7cdf9e3

Please sign in to comment.