Code Monkey home page Code Monkey logo

Comments (1)

picnixz avatar picnixz commented on June 18, 2024 2

There is a historical reason why we have these two directives but long-story short, .. code is a docutils directive (that we support as a pure docutils) and .. code-block is a Sphinx one (which is an improvement of the latter).

We don't really want to mention the two of them because what is generally needed is the code-block directive and not the code directive. If we were to mention it, users would maybe try to use the ..code directive.

There was a very old issue (#2155) that I recently closed where it was debated whether to keep code synced with the docutils one or not. One maintainer personnally preferred merging these two together but eventually made a PR where code and code-block are distinct. While I also share this opinion, having distinct code directives might be useful for extensions that assume that the code directive is compatible with docutils and has minimal processing in their run method, so I would not change the behaviour.

Nevertheless, what we can do is mention the code directive but stress that code-block is better for most usage.

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.