From 3739a088e1249971d89e9d962ff3be57bf57795b Mon Sep 17 00:00:00 2001 From: Avi Vajpeyi Date: Thu, 5 Dec 2024 11:51:08 +1300 Subject: [PATCH 1/3] Update setup.py with more doc requirements There are some missing packages in `setup.py`[docs] compared to online_docs/requirement.txt Here we make sure both have the same stuff. TBH -- do we need anything in online_docs/requirement.txt? Or even `requirements.txt`? Isnt everything in `setup.py`? --- setup.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/setup.py b/setup.py index cfc45a311..1701ba778 100644 --- a/setup.py +++ b/setup.py @@ -44,16 +44,18 @@ ] EXTRA_REQUIRE = dict( docs=[ - "sphinx", + "sphinx>=7.0.1", "numpydoc", "nbsphinx", - "sphinx_rtd_theme", + "sphinx_rtd_theme>=1.2.2", "sphinx-tabs", "sphinx-argparse", "sphinx-math-dollar", "sphinxcontrib.bibtex", "linuxdoc", - "ipython" + "ipython", + "readthedocs-sphinx-search>=0.1.1b", + "sphinx-togglebutton", ], dev=[ "pytest-cov", From a3de92d624d81a74c121312d04a22abc1d5c6f00 Mon Sep 17 00:00:00 2001 From: avi Date: Thu, 5 Dec 2024 12:13:57 +1300 Subject: [PATCH 2/3] remove redundant files --- online-docs/.readthedocs.yaml | 15 ----------- online-docs/requirements.txt | 10 ------- requirements.txt | 49 ----------------------------------- setup.py | 11 ++++---- 4 files changed, 6 insertions(+), 79 deletions(-) delete mode 100644 online-docs/.readthedocs.yaml delete mode 100644 online-docs/requirements.txt delete mode 100644 requirements.txt diff --git a/online-docs/.readthedocs.yaml b/online-docs/.readthedocs.yaml deleted file mode 100644 index d616bd499..000000000 --- a/online-docs/.readthedocs.yaml +++ /dev/null @@ -1,15 +0,0 @@ -version: 1 - -build: - os: "ubuntu-20.04" - tools: - python: "3.12" - -# Build from the docs/ directory with Sphinx -sphinx: - configuration: conf.py - -# Explicitly set the version of Python and its requirements -python: - install: - - requirements: requirements.txt diff --git a/online-docs/requirements.txt b/online-docs/requirements.txt deleted file mode 100644 index 576eb06b0..000000000 --- a/online-docs/requirements.txt +++ /dev/null @@ -1,10 +0,0 @@ -sphinx>=7.0.1 -sphinx_rtd_theme>=1.2.2 -readthedocs-sphinx-search>=0.1.1b -sphinx-togglebutton -linuxdoc -sphinx_math_dollar -nbsphinx -numpydoc -sphinx-argparse -sphinx_tabs diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index df55164e3..000000000 --- a/requirements.txt +++ /dev/null @@ -1,49 +0,0 @@ -# File: docs/requirements.txt - -# Defining the exact version will make sure things don't break - -# sphinx is required. readthedocs does that automatically, so it doesn't need -# to be here but you will need it if you want to build the html files locally - -# seems obvious, but python is required. readthedocs does that automatically, -# so it doesn't need to be here but you will need it if you want to build the -# html files locally - -sphinx_rtd_theme==0.5.1 -sphinx-math-dollar>=1.2 - -sphinxcontrib.bibtex - -linuxdoc==20210324 - - -numpydoc -sphinx-tabs -sphinx-argparse - -nbsphinx - -ipykernel -IPython -pandas -numpy>=1.16 -# numpydoc -astropy>=4.0 -# numba>=0.50 -scipy>=1.5.0 -h5py -matplotlib>=3.3.2 -latex -PyYAML - -# The following are listed in the 'extensions []' block in conf.py -# Readthedocs doesn't want them here, but they are required if you want -# to build the html files locally -# -# matplotlib.sphinxext.plot_directive -# sphinx.ext.mathjax -# sphinx.ext.intersphinx -# matplotlib.sphinxext.plot_directive -# IPython.sphinxext.ipython_console_highlighting -# IPython.sphinxext.ipython_directive - diff --git a/setup.py b/setup.py index 1701ba778..8cf5abe20 100644 --- a/setup.py +++ b/setup.py @@ -24,7 +24,7 @@ "Programming Language :: Python :: 3", ] INSTALL_REQUIRES = [ - "numpy", + "numpy>=1.16", "h5py", "argparse", "stroopwafel", @@ -33,10 +33,10 @@ "flake8", "black==22.10.0", "isort", - "matplotlib", + "matplotlib>=3.3.2", "pandas", - "astropy", - "scipy", + "astropy>=4.0", + "scipy>=1.5.0", "latex", "PyYAML", "tqdm", @@ -50,12 +50,13 @@ "sphinx_rtd_theme>=1.2.2", "sphinx-tabs", "sphinx-argparse", - "sphinx-math-dollar", + "sphinx-math-dollar>=1.2", "sphinxcontrib.bibtex", "linuxdoc", "ipython", "readthedocs-sphinx-search>=0.1.1b", "sphinx-togglebutton", + "linuxdoc>=20210324" ], dev=[ "pytest-cov", From 2cccac0fad2fe2766a5f8afddcee8c8785a43c85 Mon Sep 17 00:00:00 2001 From: avi Date: Thu, 5 Dec 2024 12:15:09 +1300 Subject: [PATCH 3/3] specify all installs are in the pip install .[docs] --- .readthedocs.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 79a543313..73a323f2b 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -22,7 +22,6 @@ formats: [] # Set the version of Python and other tools you might need python: install: - - requirements: requirements.txt - method: pip path: . extra_requirements: