Coder Social home page Coder Social logo

Comments (5)

bbengfort avatar bbengfort commented on August 24, 2024 1

I think the documentation will be extremely important, especially since it will have to contain images, example code, and a lot of details about how to work with Yellowbrick. We're taking a lot of inspiration from Seaborn; it and the pandas documentation reveal how important it is to visually and intuitively explain how to use the library. If Sphinx will help us achieve that level of documentation (after all, both Pandas and Seaborn use Sphinx) then I'm all for it.

from yellowbrick.

bbengfort avatar bbengfort commented on August 24, 2024

Planning on moving all the documentation over to reStructuredText and Sphinx?

from yellowbrick.

lauralorenz avatar lauralorenz commented on August 24, 2024

Yes

Sent from my iPhone

On Jun 25, 2016, at 4:41 PM, Benjamin Bengfort [email protected] wrote:

Planning on moving all the documentation over to reStructuredText and Sphinx?


You are receiving this because you were assigned.
Reply to this email directly, view it on GitHub, or mute the thread.

from yellowbrick.

lauralorenz avatar lauralorenz commented on August 24, 2024

I actually assumed yall were already using sphinx; now that I'm in it I see you're actually using mkdocs which we can stick with if yall like, though I don't see anything like sphinx autodoc for autogenerated api documentation on the mkdocs guide/documentation so I personally am pro sphinx in this case

from yellowbrick.

lauralorenz avatar lauralorenz commented on August 24, 2024

I would consider the scope of this one closed by #35 and the scope of implementing it more widely to be represented by open issue #36. Reopen if you think otherwise

from yellowbrick.

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.