Git Product home page Git Product logo

Comments (4)

davidism avatar davidism commented on August 23, 2024

We aren't the maintainers of the Sphinx-Click project and don't use it for the Pallets docs, so these functions will remain here.

from pallets-sphinx-themes.

davidism avatar davidism commented on August 23, 2024

You can rely on them by using Pallets-Sphinx-Themes in your project as well. You can use the directives without using the themes themselves.

from pallets-sphinx-themes.

kdeldycke avatar kdeldycke commented on August 23, 2024

OK, fair enough. And yes, you can indeed rely on these directives without using the themes. I tested that and it works great. Here is how to:

  1. Add Pallets-Sphinx-Themes dependency
  2. Add a little workaround in Sphinx's conf.py
  3. And now you can use both .. click:example:: and .. click:run:: in your docs.

Note that both directives needs to resides in the same {eval-rst} MyST block.

from pallets-sphinx-themes.

kdeldycke avatar kdeldycke commented on August 23, 2024

For the record, I just streamlined and documented the setup of .. click:example:: and .. click:run:: directives at: https://kdeldycke.github.io/click-extra/sphinx.html

from pallets-sphinx-themes.

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.