Giter Site home page Giter Site logo

Comments (2)

isms avatar isms commented on May 28, 2024 5

Agreed (especially on MD vs rST 😓), but per our discussion yesterday I think there might be two separate use cases - not sure Mkdocs actually replaces Sphinx for code documentation. (Some limited discussion here: mkdocs/mkdocs#20)

As a counterargument, do we really expect people to write full-on docstrings in most data science code? Most of the time I'd probably choose lightweight set of doc pages like (approach, dev setup, deployment) over heavy duty Sphinx docs.

My vote is actually to allow either as a cookiecutter option.

from cookiecutter-data-science.

caduvieira avatar caduvieira commented on May 28, 2024 2

Mkdocs do not generate PDF from MD. Sphinx can generate PDF from MD http://www.sphinx-doc.org/en/stable/markdown.html

from cookiecutter-data-science.

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.