Skip to content

Commit

Permalink
[docs] requirements for readthedocs (#82)
Browse files Browse the repository at this point in the history
  • Loading branch information
stonier committed Apr 16, 2019
1 parent 63a2e59 commit 9ba7b7a
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 20 deletions.
18 changes: 9 additions & 9 deletions .readthedocs.yaml
@@ -1,4 +1,3 @@
# read-the-docs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

Expand All @@ -10,15 +9,16 @@ sphinx:
configuration: doc/conf.py
fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
# Build your docs in additional formats such as PDF and ePub
# [], all, or - epub, - pdf
formats: []

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.6
install:
- method: pip
path: .
extra_requirements:
- docs
version: 3.6
install:
- requirements: doc/requirements.txt
# Unfortunately can only do this from pip
# - method: setuptools
# path: .
# extra_requirements:
# - docs
14 changes: 14 additions & 0 deletions doc/requirements.txt
@@ -0,0 +1,14 @@
##############################################################################
#
# Requirements for sphinx documentation environment. Most dependencies
# are mocked.
#
# This file is discovered by the root level
# .readthedocs.yaml (rtd build) and docenv.bash (local build)
##############################################################################

Sphinx<2
sphinx-argparse<0.3
sphinx_rtd_theme<0.5
sphinx-autodoc-typehints==1.6.0
py_trees>=1.1
3 changes: 2 additions & 1 deletion docenv.bash
Expand Up @@ -88,7 +88,8 @@ if [ "${VIRTUAL_ENV}" == "" ]; then
fi

# Get all dependencies for doc generation
pip install -e .[docs]
# pip install -e .[docs]
pip install -r doc/requirements.txt

# NB: this automagically nabs install_requires
python setup.py develop
Expand Down
11 changes: 1 addition & 10 deletions setup.py
Expand Up @@ -5,15 +5,6 @@

package_name = 'py_trees_ros'

extras_require = {
'docs': ["Sphinx<2",
"sphinx-argparse<0.3",
"sphinx_rtd_theme<0.5",
"sphinx-autodoc-typehints==1.6.0",
'py_trees'
],
}

setup(
name=package_name,
version='1.0.0',
Expand All @@ -25,7 +16,7 @@
],
package_data={},
install_requires=[],
extras_require=extras_require,
extras_require={},
author='Daniel Stonier, Naveed Usmani, Michal Staniaszek',
maintainer='Daniel Stonier <d.stonier@gmail.com>',
url='https://github.com/splintered-reality/py_trees_ros',
Expand Down

0 comments on commit 9ba7b7a

Please sign in to comment.