summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2026-05-15Use the database for docs renderingissue-1630Charles Roelli
Co-authored-by: Paolo Melchiorre <pmelchiorre@rippling.com>
2026-05-08Add djade linter and format templates.Anshul Zilpe
2026-03-23Synced webpages from sitemap to Document model for search. (#2284)Sarah Boyce
* Synced webpages from sitemap to Document model for search. * Removed is_searchable from blog Entry model.
2026-02-19Apply formatting suggestions by PaoloSaptak Sengupta
Co-authored-by: Paolo Melchiorre <pmelchiorre@rippling.com>
2026-02-19Use `self.assertIn` instead of `self.fail`Storm B. Heg
2026-02-19Drop security.txt expiration warning in testsStorm B. Heg
2026-02-19Implement security.txt feedbackStorm B. Heg
- Serve from a view, nginx is not going to handle this for us. - Make clear what should be reported to the security@djangoproject.com and what should be reported to the website working group - Downgrade security.txt expiration test to a warning instead of a hard fail.
2026-01-16Restored search hotkey for desktop.Sarah Boyce
2025-12-30Use CSS instead of JavaScript for floating warningAdam Zapletal
Some of the functionality of the floating warning on unsupported and in-development documentation versions was implemented using JavaScript. This is longer necessary if we use the following approach with modern CSS: Attach the warning element the top of the page with `position: sticky`. This almost solves the problem, but we still have to scroll past header elements when an internal page link is clicked. This is achieved with a combination of the `:has` pseudo-class and the `scroll-margin-top` property. We apply `scroll-margin-top` to elements that can be scrolled to by their `id` attribute. This is done with responsive breakpoints to get appropriate spacing when the floating warning has one, two, or three lines of text. Thanks to `:has`, this only happens when a warning element is on the page. The modern CSS features used are widely-supported: - https://caniuse.com/css-has - https://caniuse.com/css-sticky - https://caniuse.com/mdn-css_properties_scroll-margin-top Other than making the primary CSS changes and removing the related JavaScript, this patch does the following: - Simplify the CSS so that the class on all floating warning elements implements the common rules and the CSS for the IDs on the elements implements the colors - Add a `z-index` to warning elements so that they always display in front of the header element - Move the floating warning element to the top of the page in the HTML - Remove the `body_extra` block that was only being used by the floating warning element - Add a new `before_header` block for the floating warning element Thank you to Baptiste Mispelon and Thibaud Colas for helping me arrive at this solution.
2025-12-18Reversed the order of languages and versions.Sarah Boyce
2025-12-18Removed relative urls.Sarah Boyce
2025-12-18feat: Make top_corporate_members more genericamichon
2025-12-15Made the language and documentation version switcher accessible by keyboard.Sarah Boyce
2025-12-03Updated docs-related model fixtures for 6.0 release.Natalia
2025-11-27Preserved category filter between searches.Sarah Boyce
2025-11-24Removed references to "Documentation" in search as now a global search.Sarah Boyce
2025-11-24Make use of Pathlib's "/"Ülgen Sarıkavak
It provides a cleaner and easier to read experience, comparing to .joinpath()
2025-11-21Moved docs search bar to top navigation in prep for global search.Sarah Boyce
2025-11-21Added DEFAULT_LANGUAGE_CODE setting.Sarah Boyce
2025-11-07Excluded website Documents from DocsSitemap.Sarah Boyce
2025-11-07Added support for searching ecosystem and blog entries.Tim Schilling
The blog results should have a property of whether it is included in the search results. * Added is_searchable. * Used Entry.get_absolute_url to encapsulate www host. * Extracted get_search_config helper function. Co-authored-by: Baptiste Mispelon <bmispelon@gmail.com>
2025-10-22Fixed translations of results count for languages where 0 is singular rather ↵Sarah Boyce
than plural.
2025-10-21Fixed language switcher on search results pages (#2272)RUDRAKSH FANSE
* Fix language switcher on search results pages * Makefile delete revert
2025-09-25Add top `CorporateMember`s to `docs` sidebarAdam Zapletal
This was requested by the fundraising working group. I abstracted the top `CorporateMember` display from the `releases` app sidebar into a new inclusion tag called `top_corporate_members` and included it in its original place as well as in the `docs` sidebar as requested. Uploaded images for `CorporateMember`s may not display in local development environments do to the way media files paths work with subdomains.
2025-09-20Updated translationsTobias McNulty
2025-09-19Replaced search field with generated vector field (#2192)Paolo Melchiorre
2025-09-12Updated translationsTobias McNulty
2025-07-01Removes fellow application bannerSaptak S
2025-06-12Added Fellow call for applicant banner.Sarah Boyce
2025-06-12Speed up initial docs generation by setting the git clone depth to 1. (#2093)Alex
* Speed up initial docs cloning --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2025-05-20[docs] Fixed stable symlink not updating when changedBaptiste Mispelon
2025-04-09Added documentation type filtering to search.Sarah Boyce
Thank you to Paulo Melchiorre, Tom Carrick, Marijke Luttekes, and Baptiste Mispelon for the reviews.
2025-04-09Updated the search_result.html page to use modern template tags.Sarah Boyce
2025-04-09Improved accessibility of documentation search.Sarah Boyce
Thank you Marijke Luttekes for the review.
2025-04-02Used joining instead of prefetching in Document.search()Baptiste Mispelon
The FK relationship between the models lends itself well to a select_related() instead of a prefetch_related(). Additionally, this gets around a bug in 5.2 (initial release).
2025-04-02Updated docs-related model fixtures for 5.2 release.Sarah Boyce
2025-03-30Restored serving of spinx _imagesBaptiste Mispelon
This is a partial revert of efc51e848d870d4c7675f6636b9893324ba3bc3f. Due to an unfortunate conflict in the nginx configuration of the server after the deploying of the commit mentioned above, the _images directory ended up still being served by Django which added a / to the end of the image path, using a permanent HTTP redirection (because of settings.APPEND_SLASH). The solution (hopefully temporary) is to restore the serving of images by Django while we figure out how to configure nginx to keep serving the _images and handled the old cached redirections with a trainling slash.
2025-03-28Fixed crash when running docs site with DEBUG=TrueBaptiste Mispelon
This was missed in efc51e848d870d4c7675f6636b9893324ba3bc3f
2025-03-27Enabled serving of sphinx build files in DEBUG mode onlyBaptiste Mispelon
2025-03-14Added Sphinx clean up global state call.Sarah Boyce
2025-03-14Reapply "Fixed page header structure and used semantic HTML."Baptiste Mispelon
This reverts commit f1fca5e8a412da1bb8b5ffd11a59eac8579738bb.
2025-03-14Set Sphinx verbosity to 0.Sarah Boyce
2025-03-14Prevented Sphinx global state interfering with builds.Sarah Boyce
2025-03-13Improved Release model to support PEP625 changes.Baptiste Mispelon
Three new file fields (tarball, wheel, checksum) were added, making the link generation to these files more robust to changes like the one mandated by PEP625 (changing of file case). A new is_active boolean field was also added, making it easier to start work on a release without it being public.
2025-03-11Revert "Fixed page header structure and used semantic HTML."Baptiste Mispelon
This reverts commit f87e1dbd3c06fe9b1100ddcd06394de5ae338577.
2025-03-11Decreased verbosity required to get indexing durationBaptiste Mispelon
2025-03-11Marked custom sphinx builder as parallel-safeBaptiste Mispelon
2025-03-11Reapply "Added code references to search results. (#1947)"Baptiste Mispelon
This reverts commit af929f0734c319447a061e82b0353fc48b792ec4.
2025-03-11Fixed page header structure and used semantic HTML.Sarah Boyce
2025-03-05Revert "Added code references to search results. (#1947)"Alex
This reverts commit fa56d9b841e0bd23c5c8871826ba6abe2205fdb4.