Git Product home page Git Product logo

Comments (5)

uranusjr avatar uranusjr commented on June 15, 2024 1

It would be best of someone could help set up things for me, of course! Once Sphinx is set up I can configure RTD for this.

from resolvelib.

pombredanne avatar pombredanne commented on June 15, 2024

@uranusjr ack... I'll try to get down to something ... FWIW this is the tool we are using it in: https://github.com/nexB/python-inspector

from resolvelib.

pombredanne avatar pombredanne commented on June 15, 2024

@TG1999 ping

from resolvelib.

pradyunsg avatar pradyunsg commented on June 15, 2024

I am currently mapping the entire public API, to figure out what the documentation needs to look like. Here's what I have at the moment:

resolvelib

    AbstractProvider
        AbstractProvider.identify()
        AbstractProvider.get_preference()
        AbstractProvider.find_matches()
        AbstractProvider.is_satisfied_by()
        AbstractProvider.get_dependencies()
    AbstractResolver
        AbstractResolver.base_exception
        AbstractResolver.__init__()
        AbstractResolver.resolve()
    BaseReporter
        BaseReporter.starting()
        BaseReporter.starting_round()
        BaseReporter.ending_round()
        BaseReporter.ending()
        BaseReporter.adding_requirement()
        BaseReporter.resolving_conflicts()
        BaseReporter.rejecting_candidate()
        BaseReporter.pinning()
    InconsistentCandidate
        InconsistentCandidate.__init__()
    Resolver
        Resolver.base_exception
        Resolver.resolve()
    RequirementsConflicted
        RequirementsConflicted.__init__()
    ResolutionError
    ResolutionImpossible
        ResolutionImpossible.__init__()
    ResolutionTooDeep
        ResolutionTooDeep.__init__()

resolvelib.reporters

    BaseReporter
        BaseReporter.starting()
        BaseReporter.starting_round()
        BaseReporter.ending_round()
        BaseReporter.ending()
        BaseReporter.adding_requirement()
        BaseReporter.resolving_conflicts()
        BaseReporter.rejecting_candidate()
        BaseReporter.pinning()

resolvelib.resolvers

    Result
        Result.mapping
        Result.graph
        Result.criteria
        Result.__new__()
    ResolverException
    RequirementsConflicted
        RequirementsConflicted.__init__()
    InconsistentCandidate
        InconsistentCandidate.__init__()
    ResolutionError
    ResolutionImpossible
        ResolutionImpossible.__init__()
    ResolutionTooDeep
        ResolutionTooDeep.__init__()
    Resolution
        Resolution.__init__()
    AbstractResolver
        AbstractResolver.base_exception
        AbstractResolver.__init__()
        AbstractResolver.resolve()
    Resolver
        Resolver.base_exception
        Resolver.resolve()

resolvelib.structs

    RequirementInformation
        RequirementInformation.requirement
        RequirementInformation.parent
        RequirementInformation.__new__()
    State
        State.mapping
        State.criteria
        State.backtrack_causes
        State.__new__()
    DirectedGraph
        DirectedGraph.__init__()
        DirectedGraph.copy()
        DirectedGraph.add()
        DirectedGraph.remove()
        DirectedGraph.connect()
    IteratorMapping
        IteratorMapping.__init__()
    IterableView
    build_iter_view()
    Criterion
        Criterion.__init__()

I don't really enjoy that there's a bunch of thing re-exported at multiple levels and things are being imported (and used) from places where they're not really supposed to be public API.

from resolvelib.

pradyunsg avatar pradyunsg commented on June 15, 2024

https://readthedocs.org/dashboard/resolvelib/ is a thing, I'll file a PR for adding documentation soon.

from resolvelib.

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.