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

Remove Sphinx as a required dependency #15

Merged
merged 6 commits into from
Jan 13, 2024

Conversation

phlax
Copy link
Contributor

@phlax phlax commented Aug 24, 2023

No description provided.

Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax force-pushed the square-dependencies branch from 0032624 to 32d5a29 Compare August 24, 2023 15:39
Signed-off-by: Ryan Northey <ryan@synca.io>
@phlax phlax force-pushed the square-dependencies branch from 3415bc0 to b8dc42f Compare September 1, 2023 10:24
@andy-maier
Copy link

Gentle reminder to get this in. We are also hampered by the circular dependency (using pipdeptree).

CHANGES Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@AA-Turner AA-Turner changed the title deps: Make Sphinx optional Remove Sphinx as a required dependency Jan 13, 2024
CHANGES Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@AA-Turner AA-Turner merged commit 9658d29 into sphinx-doc:master Jan 13, 2024
8 checks passed
AA-Turner added a commit that referenced this pull request Jan 13, 2024
Signed-off-by: Ryan Northey <ryan@synca.io>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@mvorisek
Copy link

@AA-Turner Please revert, the dep is needed, it has broken our CIs:

Run mv docs/baseline.txt docs/baseline.orig.txt
  mv docs/baseline.txt docs/baseline.orig.txt
  (cd docs && python -m sphinx -T -b html . out 2>&1 | tee baseline.txt)
  sed -i -r 's~[^:]*/docs/([^:]*:)([0-9]+:)?~\1~;t;d' docs/baseline.txt
  shell: sh -e {0}
Running Sphinx v4.5.0

Traceback (most recent call last):
  File "/usr/lib/python3.11/site-packages/sphinx/registry.py", line 438, in load_extension
    metadata = setup(app)
               ^^^^^^^^^^
  File "/usr/lib/python3.11/site-packages/sphinxcontrib/applehelp/__init__.py", line 230, in setup
    app.require_sphinx('5.0')
  File "/usr/lib/python3.11/site-packages/sphinx/application.py", line 393, in require_sphinx
    raise VersionRequirementError(version)
sphinx.errors.VersionRequirementError: 5.0

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/lib/python3.11/site-packages/sphinx/cmd/build.py", line 272, in build_main
    app = Sphinx(args.sourcedir, args.confdir, args.outputdir,
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.11/site-packages/sphinx/application.py", line 219, in __init__
    self.setup_extension(extension)
  File "/usr/lib/python3.11/site-packages/sphinx/application.py", line 380, in setup_extension
    self.registry.load_extension(self, extname)
  File "/usr/lib/python3.11/site-packages/sphinx/registry.py", line 441, in load_extension
    raise VersionRequirementError(
sphinx.errors.VersionRequirementError: The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.

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.

@AA-Turner
Copy link
Member

You're using Sphinx v4.5.0, which is no longer supported -- if you require Sphinx 4 still, you'll have to pin dependencies.

A

@mvorisek
Copy link

mvorisek commented Jan 14, 2024

@AA-Turner let's do a Sphinx 4.5.1 patch release then fix with https://github.com/sphinx-doc/sphinx/blob/v4.5.0/setup.py#L17 line changed to:

-    'sphinxcontrib-applehelp',
+    'sphinxcontrib-applehelp<=1.0.4',

in 5.x, 6.x, 7.x this needs to be done too to prevent simillar issue in the future

astrsh added a commit to PolyhedralDev/TerraDocs that referenced this pull request Feb 12, 2024
CI got broken as the sphinxcontrib.applehelp extension was changed to
require Sphinx version 5.0.0+ in patch bump here:
sphinx-doc/sphinxcontrib-applehelp#15

Dependencies have been bumped to fix this.

This slightly changes some styling, file name styling in code block captions
is a little broken, will need to fix later.

Did not do much in-depth investigation if anything else is broken, but
skimmed through most pages and they look fine.
github-actions bot pushed a commit to PolyhedralDev/TerraDocs that referenced this pull request Feb 12, 2024
CI got broken as the sphinxcontrib.applehelp extension was changed to
require Sphinx version 5.0.0+ in patch bump here:
sphinx-doc/sphinxcontrib-applehelp#15

Dependencies have been bumped to fix this.

This slightly changes some styling, file name styling in code block captions
is a little broken, will need to fix later.

Did not do much in-depth investigation if anything else is broken, but
skimmed through most pages and they look fine.
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 this pull request may close these issues.

4 participants