8000 Formatted and added docs_require · Kith78/spatialmath-python@bbdbdbc · GitHub
[go: up one dir, main page]
Skip to content

Commit bbdbdbc

Browse files
jhavljhavl
committed
Formatted and added docs_require
1 parent d38d523 commit bbdbdbc

File tree

1 file changed

+28
-40
lines changed

1 file changed

+28
-40
lines changed

‎setup.py

Lines changed: 28 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,66 +4,54 @@
44
here = path.abspath(path.dirname(__file__))
55

66
# Get the long description from the README file
7-
with open(path.join(here, 'README.md'), encoding='utf-8') as f:
7+
with open(path.join(here, "README.md"), encoding="utf-8") as f:
88
long_description = f.read()
99

1010
# Get the release/version string
11-
with open(path.join(here, 'RELEASE'), encoding='utf-8') as f:
11+
with open(path.join(here, "RELEASE"), encoding="utf-8") as f:
1212
release = f.read()
1313

14+
docs_req = ["sphinx", "sphinx_rtd_theme", "sphinx-autorun", "sphinxcontrib-jsmath"]
1415

1516
setup(
16-
name='spatialmath-python',
17-
17+
name="spatialmath-python",
1818
version=release,
19-
2019
# This is a one-line description or tagline of what your project does. This
2120
# corresponds to the "Summary" metadata field:
22-
description='Provides spatial maths capability for Python.', # TODO
23-
21+
description="Provides spatial maths capability for Python.", # TODO
2422
long_description=long_description,
25-
long_description_content_type='text/markdown',
26-
23+
long_description_content_type="text/markdown",
2724
classifiers=[
2825
# 3 - Alpha
2926
# 4 - Beta
3027
# 5 - Production/Stable
31-
'Development Status :: 4 - Beta',
32-
28+
"Development Status :: 4 - Beta",
3329
# Indicate who your project is intended for
34-
'Intended Audience :: Developers',
30+
"Intended Audience :: Developers",
3531
# Pick your license as you wish (should match "license" above)
36-
'License :: OSI Approved :: MIT License',
37-
32+
"License :: OSI Approved :: MIT License",
3833
# Specify the Python versions you support here. In particular, ensure
3934
# that you indicate whether you support Python 2, Python 3 or both.
40-
'Programming Language :: Python :: 3.6',
41-
'Programming Language :: Python :: 3.7',
42-
'Programming Language :: Python :: 3.8',
43-
'Programming Language :: Python :: 3.9',
44-
],
45-
46-
python_requires='>=3.6',
47-
35+
"Programming Language :: Python :: 3.6",
36+
"Programming Language :: Python :: 3.7",
37+
"Programming Language :: Python :: 3.8",
38+
"Programming Language :: Python :: 3.9",
39+
],
40+
python_requires=">=3.6",
4841
project_urls={
49-
'Documentation': 'https://petercorke.github.io/spatialmath-python',
50-
'Source': 'https://github.com/petercorke/spatialmath-python',
51-
'Tracker': 'https://github.com/petercorke/spatialmath-python/issues',
52-
'Coverage': 'https://codecov.io/gh/petercorke/spatialmath-python'
42+
"Documentation": "https://petercorke.github.io/spatialmath-python",
43+
"Source": "https://github.com/petercorke/spatialmath-python",
44+
"Tracker": "https://github.com/petercorke/spatialmath-python/issues",
45+
"Coverage": "https://codecov.io/gh/petercorke/spatialmath-python",
5346
},
54-
55-
url='https://github.com/petercorke/spatialmath-python',
56-
57-
author='Peter Corke',
58-
59-
author_email='rvc@petercorke.com', # TODO
60-
61-
keywords='python SO2 SE2 SO3 SE3 twist translation orientation rotation euler-angles roll-pitch-yaw roll-pitch-yaw-angles quaternion unit-quaternion rotation-matrix transforms robotics robot vision pose',
62-
63-
license='MIT', # TODO
64-
47+
url="https://github.com/petercorke/spatialmath-python",
48+
author="Peter Corke",
49+
author_email="rvc@petercorke.com", # TODO
50+
keywords="python SO2 SE2 SO3 SE3 twist translation orientation rotation euler-angles roll-pitch-yaw roll-pitch-yaw-angles quaternion unit-quaternion rotation-matrix transforms robotics robot vision pose",
51+
license="MIT", # TODO
6552
packages=find_packages(exclude=["test_*", "TODO*"]),
66-
67-
install_requires=['numpy', 'scipy', 'matplotlib', 'colored', 'ansitable', 'sphinxcontrib-jsmath']
68-
53+
install_requires=["numpy", "scipy", "matplotlib", "colored", "ansitable"],
54+
extras_require={
55+
"docs": docs_req,
56+
},
6957
)

0 commit comments

Comments
 (0)
0