Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make html returns error due to conflicting Sphinx version specification in requirements.txt #6

Open
mmdurrant opened this issue Jan 31, 2024 · 0 comments · May be fixed by #7
Open

Comments

@mmdurrant
Copy link

Environment:
Python 3.10
Windows 10
Git commit hash 41df438

Running the installation directions as specified resulted in:

Running Sphinx v4.4.0

Sphinx version error:
The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.```

----- 

Changing the requirements.txt to specify `sphinx>=5.0` resulted in the following... 

```D:\Projects\_ESC\after-effects-plugin-guide>cat requirements.txt
sphinx>=5.0.0
sphinx_rtd_theme
sphinx_rtd_dark_mode
docutils<0.18

D:\Projects\_ESC\after-effects-plugin-guide>pip install -r requirements.txt
Collecting sphinx>=5.0
  Downloading sphinx-7.2.6-py3-none-any.whl (3.2 MB)
     ---------------------------------------- 3.2/3.2 MB 1.3 MB/s eta 0:00:00
Requirement already satisfied: sphinx_rtd_theme in c:\python310\lib\site-packages (from -r requirements.txt (line 2)) (1.3.0)
Requirement already satisfied: sphinx_rtd_dark_mode in c:\python310\lib\site-packages (from -r requirements.txt (line 3)) (1.3.0)
Requirement already satisfied: docutils<0.18 in c:\python310\lib\site-packages (from -r requirements.txt (line 4)) (0.17.1)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (2.0.5)
Requirement already satisfied: sphinxcontrib-qthelp in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (1.0.7)
Requirement already satisfied: snowballstemmer>=2.0 in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (2.2.0)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (1.1.10)
Requirement already satisfied: Pygments>=2.14 in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (2.17.2)
  Downloading sphinx-7.2.5-py3-none-any.whl (3.2 MB)
     ---------------------------------------- 3.2/3.2 MB 1.7 MB/s eta 0:00:00
  Downloading sphinx-7.2.4-py3-none-any.whl (3.2 MB)
     ---------------------------------------- 3.2/3.2 MB 1.8 MB/s eta 0:00:00
  Downloading sphinx-7.2.3-py3-none-any.whl (3.2 MB)
     ---------------------------------------- 3.2/3.2 MB 2.0 MB/s eta 0:00:00
  Downloading sphinx-7.2.2-py3-none-any.whl (3.2 MB)
     ---------------------------------------- 3.2/3.2 MB 2.0 MB/s eta 0:00:00
  Downloading sphinx-7.2.1-py3-none-any.whl (3.2 MB)
     ---------------------------------------- 3.2/3.2 MB 2.0 MB/s eta 0:00:00
  Downloading sphinx-7.2.0-py3-none-any.whl (3.2 MB)
     ---------------------------------------- 3.2/3.2 MB 1.0 MB/s eta 0:00:00
  Downloading sphinx-7.1.2-py3-none-any.whl (3.2 MB)
     ---------------------------------------- 3.2/3.2 MB 1.6 MB/s eta 0:00:00
  Downloading sphinx-7.1.1-py3-none-any.whl (3.2 MB)
     ---------------------------------------- 3.2/3.2 MB 1.6 MB/s eta 0:00:00
  Downloading sphinx-7.1.0-py3-none-any.whl (3.2 MB)
     ---------------------------------------- 3.2/3.2 MB 2.4 MB/s eta 0:00:00
  Downloading sphinx-7.0.1-py3-none-any.whl (3.0 MB)
     ---------------------------------------- 3.0/3.0 MB 1.8 MB/s eta 0:00:00
  Downloading sphinx-7.0.0-py3-none-any.whl (3.0 MB)
     ---------------------------------------- 3.0/3.0 MB 2.3 MB/s eta 0:00:00
Requirement already satisfied: babel>=2.9 in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (2.14.0)
Requirement already satisfied: packaging>=21.0 in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (23.2)
Requirement already satisfied: colorama>=0.4.5 in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (0.4.6)
Requirement already satisfied: sphinxcontrib-jsmath in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (1.0.1)
Requirement already satisfied: sphinxcontrib-applehelp in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (1.0.8)
Requirement already satisfied: Jinja2>=3.0 in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (3.1.3)
Requirement already satisfied: alabaster<0.8,>=0.7 in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (0.7.16)
Requirement already satisfied: requests>=2.25.0 in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (2.31.0)
Requirement already satisfied: imagesize>=1.3 in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (1.4.1)
  Downloading sphinx-6.2.1-py3-none-any.whl (3.0 MB)
     ---------------------------------------- 3.0/3.0 MB 2.4 MB/s eta 0:00:00
  Downloading sphinx-6.2.0-py3-none-any.whl (3.0 MB)
     ---------------------------------------- 3.0/3.0 MB 1.7 MB/s eta 0:00:00
  Downloading sphinx-6.1.3-py3-none-any.whl (3.0 MB)
     ---------------------------------------- 3.0/3.0 MB 2.0 MB/s eta 0:00:00
  Downloading sphinx-6.1.2-py3-none-any.whl (3.0 MB)
     ---------------------------------------- 3.0/3.0 MB 2.1 MB/s eta 0:00:00
  Downloading sphinx-6.1.1-py3-none-any.whl (3.0 MB)
     ---------------------------------------- 3.0/3.0 MB 2.5 MB/s eta 0:00:00
  Downloading sphinx-6.1.0-py3-none-any.whl (3.0 MB)
     ---------------------------------------- 3.0/3.0 MB 2.1 MB/s eta 0:00:00
  Downloading sphinx-6.0.1-py3-none-any.whl (3.0 MB)
     ---------------------------------------- 3.0/3.0 MB 1.0 MB/s eta 0:00:00
  Downloading sphinx-6.0.0-py3-none-any.whl (3.0 MB)
     ---------------------------------------- 3.0/3.0 MB 593.4 kB/s eta 0:00:00
  Downloading sphinx-5.3.0-py3-none-any.whl (3.2 MB)
     ---------------------------------------- 3.2/3.2 MB 1.2 MB/s eta 0:00:00
Requirement already satisfied: sphinxcontrib-devhelp in c:\python310\lib\site-packages (from sphinx>=5.0->-r requirements.txt (line 1)) (1.0.6)
Requirement already satisfied: sphinxcontrib-jquery<5,>=4 in c:\python310\lib\site-packages (from sphinx_rtd_theme->-r requirements.txt (line 2)) (4.1)
Requirement already satisfied: MarkupSafe>=2.0 in c:\python310\lib\site-packages (from Jinja2>=3.0->sphinx>=5.0->-r requirements.txt (line 1)) (2.1.4)
Requirement already satisfied: idna<4,>=2.5 in c:\python310\lib\site-packages (from requests>=2.25.0->sphinx>=5.0->-r requirements.txt (line 1)) (3.6)
Requirement already satisfied: certifi>=2017.4.17 in c:\python310\lib\site-packages (from requests>=2.25.0->sphinx>=5.0->-r requirements.txt (line 1)) (2023.11.17)
Requirement already satisfied: urllib3<3,>=1.21.1 in c:\python310\lib\site-packages (from requests>=2.25.0->sphinx>=5.0->-r requirements.txt (line 1)) (2.2.0)
Requirement already satisfied: charset-normalizer<4,>=2 in c:\python310\lib\site-packages (from requests>=2.25.0->sphinx>=5.0->-r requirements.txt (line 1)) (3.3.2)
Installing collected packages: sphinx
  Attempting uninstall: sphinx
    Found existing installation: Sphinx 4.4.0
    Uninstalling Sphinx-4.4.0:
      Successfully uninstalled Sphinx-4.4.0
Successfully installed sphinx-5.3.0

[notice] A new release of pip available: 22.2.2 -> 23.3.2
[notice] To update, run: python.exe -m pip install --upgrade pip```

I'm submitting a followup PR to fix the requirements.txt but wanted to make sure I documented the issue so you had context. 
@mmdurrant mmdurrant linked a pull request Jan 31, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant