Comments (6)
We should set a manual description for this function, and refer to Werkzeug docs (see intersphinx for that).
Another reason for a necessary rephrasing is that "return a WSGI application" is unnecessarily low-level for Flask's docs, and only appropriate for Werkzeug's.
from pallets-sphinx-themes.
@untitaker really not sure what to do here. Maybe there's a way to indicate the package as well as the version for externals we're re-documenting? Or disable the versions in those cases? This came up while looking at pallets/flask#1704.
from pallets-sphinx-themes.
Similar to how I wrote a plugin to collapse old version directives, maybe we can write a plugin that adds "Werkzeug version ...". That would be a lot more maintainable.
from pallets-sphinx-themes.
I apologize if this is more general, but what level of technical detail is desired when writing Flask docs? I wouldn't consider mentioning WSGI to be low-level, but can understand if that's meant to be abstracted.
from pallets-sphinx-themes.
I don't have a particular problem with how the API docs read currently. If we need to simplify something that can be done at a later time.
from pallets-sphinx-themes.
I've started investigating this. It's going to be messy, but I think it's possible.
The sphinx.domains.changeset.VersionChange
directive class controls the version messages. Unfortunately, it's not designed to be overridden, the sphinx.domains.changeset.versionlabels
dict has strings that expect one %s
substitution only, such as 'Changed in version %s'
. This substitution is done a few lines in to the VersionChange.run
method. We'll have to copy and modify the code for that method.
Once we do that, we can look up VersionChange.source
in intersphinx. If it's not there, we can fall back to the source package name instead of the intersphinx title. If there's no intersphinx method for looking it up, we can fall back to scanning VersionChange.env.intersphinx_inventory
.
Still need to investigate how we could determine if the source is the current package being documented, or an inherited method. That way we could exclude the package name if it's the current package. I think I'd actually prefer everything to have package names consistently though.
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
- Move `.. click:example::` and `.. click:run::` implementation to `sphinx-click` HOT 4
- 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
- We're planning to switch to Furo as a base theme, which will provide a dark mode. 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.