From b2cd8260463d21bd85b1db676689b7d253d34b48 Mon Sep 17 00:00:00 2001 From: Poruri Sai Rahul Date: Wed, 14 Jul 2021 15:43:13 +0530 Subject: [PATCH] DEV : Add a RtD config file and add a "docs" extras_require to make it easy to build the documentation new file: .readthedocs.yaml modified: setup.py --- .readthedocs.yaml | 12 ++++++++++++ setup.py | 5 +++++ 2 files changed, 17 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..963f56f --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,12 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +python: + version: 3.8 + install: + - method: pip + path: . + extra_requirements: + - docs diff --git a/setup.py b/setup.py index c8da369..6f0f9de 100644 --- a/setup.py +++ b/setup.py @@ -113,6 +113,10 @@ def write_version_py(filename=DEFAULT_VERSION_FILE, 'scipy', ] +EXTRAS_REQUIRE = { + "docs": ["enthought-sphinx-theme", "sphinx"], +} + if __name__ == "__main__": __version__ = write_version_py() @@ -163,6 +167,7 @@ def write_version_py(filename=DEFAULT_VERSION_FILE, ext_modules=extensions, packages=find_packages(exclude=['docs', 'examples']), install_requires = DEPENDENCIES, + extras_require = EXTRAS_REQUIRE, license = "BSD", package_data = {'': ['images/*', 'data/*', 'scimath/units/data/*']}, platforms = ["Windows", "Linux", "Mac OS-X", "Unix", "Solaris"],