DOC - Add Falcon web framework to the gallery #2165
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As of Falcon 4.0.0, the framework has adopted PyData Sphinx Theme for docs. Examples can be found here: * stable -- https://falcon.readthedocs.io/ * latest -- https://falcon.readthedocs.io/en/latest/
gabalafou
approved these changes
Apr 2, 2025
There was a problem hiding this comment.
Looks good to me, glad you had a mostly positive experience.
Re: table of contents syncing - this should be mostly fixed in the next release
Re: jumbled header at intermediate widths - this isn't in anyone's immediate plans to fix, but we are aware of the problem and we're not happy with it either. See also the conversation on #2117.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As of Falcon 4.0.0, the framework has adopted PyData Sphinx Theme for docs.
Rendered examples can be found on ReadTheDocs:
We have customized the look and feel somewhat (including light/dark themes, custom icons, and own Pygments styles) but I shied away from proposing this for Featured for now 😅
So far the experience has been mostly positive, this is a great theme: easy to support both light and dark themes, both desktop and mobile out of the box. 💯
If I were to find minor nitpicks/complaints, I think we saw a variation of #1889 on the right sidebar, don't remember what triggers that and whether we had a good example; also I'm not convinced about how the layout is condensed in the interim version between wide desktop and mobile: headings word wrapped into two lines is OK by me, but the way icons and buttons get scattered on the right side is IMHO somewhat peculiar:
