Comments (4)
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.
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.
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:
- Add
Pallets-Sphinx-Themes
dependency - Add a little workaround in Sphinx's
conf.py
- 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.
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)
- Differentiate between Jinja filter and test names HOT 1
- In sidebar, add links to the reST sources (aka html_show_sourcelink). HOT 1
- Sticky menus HOT 2
- The 404 page contains incorrect static URLs
- Search is not getting correct url root HOT 1
- see if we can remove the rtd docsearch_disabled flag
- add ethicalads.io placeholder div
- Search on Flask/Werkzeug/jinja... website is broken (redirect loop) HOT 1
- Incorrect canonical links on project website HOT 2
- dark mode HOT 6
- 2.0.1: DeprecationWarning HOT 4
- Change the font for better readability HOT 1
- RTL not supported in Sphinx flask theme HOT 1
- Extension error on sphinx-build: cannot import name pass_context from jinja2 HOT 3
- Remove version info from Werkzeug in the docs HOT 6
- Documentation contents obscure actual documentation HOT 2
- pallests-sphinx-themes 2.0.2 is not compatible with latest packaging release HOT 1
- chrome underline dots somewhat big HOT 1
- Support for Sphinx parallel build HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pallets-sphinx-themes.