Merge pull request #305 from stfc/304_rtd_build_fix

#304 add pip_requirements file and doc target in setup.py

CHANGELOG.md

@@ -15,6 +15,10 @@ Modifications by (in alphabetical order):
 * P. Vitt, University of Siegen, Germany
 * A. Voysey, UK Met Office
 
+02/12/2021 PR #305 for #304. Fix failing build of documentation on RTD.
+
+## Release 0.0.13 (02/11/2021) ##
+
 02/11/2021 #303: create release 0.0.13.
 
 04/10/2021 PR #302 for #301. Improved handling of constants with exponents.
@@ -23,6 +27,8 @@ Modifications by (in alphabetical order):
 
 12/08/2021 #299. Fix to logging test in fparser1 tests.
 
+## Release 0.0.12 (26/04/2021) ##
+
 26/04/2021 #296. Create release 0.0.12.
 
 21/04/2021 PR #260 for #253. Bug fix to improve Io_Control_Spec and

doc/pip_requirements.txt

@@ -0,0 +1,38 @@
+# -----------------------------------------------------------------------------
+# BSD 3-Clause License
+#
+# Copyright (c) 2021, Science and Technology Facilities Council.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# * Neither the name of the copyright holder nor the names of its
+#   contributors may be used to endorse or promote products derived from
+#   this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+
+# pip requirements file specifying the packages required to build
+# the fparser documentation. Used by readthedocs.
+sphinx
+sphinxcontrib.bibtex

setup.py

@@ -121,6 +121,9 @@
         packages=PACKAGES,
         package_dir={"": "src"},
         install_requires=['six'],
+        extras_require={
+            'doc': ["sphinx", "sphinx_rtd_theme"]
+        },
         entry_points={
             'console_scripts': [
                 'fparser2=fparser.scripts.fparser2:main',