Git Product home page Git Product logo

Comments (5)

mgorny avatar mgorny commented on June 12, 2024 2

I think it would also be useful to avoid importing defusedxml in global scope. It is only used by etree_parse(), and not every consumer of sphinx.testing uses this function.

For example, breathe is currently broken by this. However, it does not use this API and without the import in global scope, it doesn't have to be updated to depend on defusedxml (or sphinx[dev], as suggested above).

from sphinx.

picnixz avatar picnixz commented on June 12, 2024 1

Ok, I see what happened actually. It's because the dependencies of sphinxcontrib- were not updated accordingly, namely we are installing sphinx as sphinx (so we are only using the release dependencies and not the test dependencies for sphinx).

Is there a way to tell tox to install the sphinx test dependencies in tox.ini?

PS: The argument against adding defusedxml as a runtime dependency is that, for consistency, we would also need to add pytest as a runtime dependency since we are using pytest in sphinx.testing.fixture. One could argue that because one should have pytest for using the plugin, we don't need that but technically speaking, both of them should then be present.

Now, I am willing to actually split the test dependencies into dev and test dependencies where dev dependencies would be those needed by extensions and test dependencies would only be for our tests (in particular, test would be a superset of dev, e.g., this would include cython and setuptools packages).

from sphinx.

jdillard avatar jdillard commented on June 12, 2024

I asked a similar question here: https://github.com/orgs/sphinx-doc/discussions/12333

Happy to close the discussion if this is a better place.

from sphinx.

picnixz avatar picnixz commented on June 12, 2024

No, but we should have a better tox.ini which would setup the environment correctly.

from sphinx.

chrisjsewell avatar chrisjsewell commented on June 12, 2024

Now, I am willing to actually split the test dependencies into dev and test

yes I feel this is what should happen; I was about to say, your first responses seemed to be conflating sphinx internal development with the actual opened issue of users interacting with sphinx.testing.fixture πŸ˜…

(in general, it is a bit of an open question in python packaging, where/how you define internal development dependencies vs defining extra user dependencies)

from sphinx.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.