Commit Graph

31 Commits

Author SHA1 Message Date
Code Apprentice
047bec1288
Add documentation to show how to add authentication for the browseable api (#9137) 2024-01-04 14:16:57 +00:00
Yousef Abu Shanab
530baa23cd
Add 2 customization packages, rest-framework-redesign and rest-framework-material (#9088) 2024-01-04 12:42:54 +00:00
mschmidm
99cf2c415f
Docs: Updated browsable-api.md (#8678)
- Replace the broken Bootswatch-Link with an Jsdelivr-Link as suggested at https://bootswatch.com/help/
- Updated the stated Bootstrap version
- Added a note that the Bootstrap version must match the default one

Co-authored-by: Tom Christie <tom@tomchristie.com>
2022-10-04 12:15:51 +01:00
Cyrus Ghazanfar
7ad5bdb669 Adjusted login template override example (#6265) 2018-12-19 15:25:34 +01:00
Jon Dufresne
d3f3c3d9c1 Prefer https protocol for links in docs when available 2018-01-15 15:15:21 +01:00
Jon Dufresne
d5c34aa813 Remove unused links from docs (#5735)
Each removed link has no inline use.
2018-01-15 15:03:44 +01:00
Tom Christie
e7483133ea Update browsable-api.md 2017-05-01 11:49:42 +01:00
Adam Chainz
e3337ab4aa Convert readthedocs link for their .org -> .io migration for hosted projects
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’:

> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

Test Plan: Manually visited all the links I’ve modified.
2016-05-29 23:26:56 +01:00
Atul Varma
66de876dee Update bootstrap version in browsable-api.md 2015-12-19 10:34:39 -05:00
Tom Christie
99d9afc9d0 Remove out-of-date note on footer block in browsable API template. Closes #3187. 2015-07-27 09:18:41 +01:00
Jared Petersen
2b2fbbd299 Update browsable-api.md
The Bootstrap Customizer has been discontinued and is no longer available (http://getbootstrap.com/2.3.2/customize.html), so I removed the reference to it in the page.
2015-06-04 21:28:21 -07:00
Tom Christie
678f7b4c65 Update notes on autocomplete 2014-11-26 10:43:45 +00:00
Tom Christie
c092b4df78 Merge pull request #1641 from javins/login-title
Refactor login template to extend base.
2014-08-18 20:28:34 +01:00
Kevin London
bc03d2b553 Updated links to Bootstrap components
The previous links landed on the the main page and no longer directly linked to specific areas.
2014-08-07 16:32:40 -07:00
Walt Javins
b4c7717cb8 Refactor login template to extend base.
While experimenting with extending DRF, I found that the login page
1) had no title, and 2) duplicated <head> info from base.html.

This change adds a new {% block body %} to the base.html template
which allows override of the entire html <body>. login_base.html
has its duplicated head info stripped, and now extends base.html
to share common html <head> templating.

As part of this change, pretify.css is unnecessarily added to
login_base.html.  If this is deemed a problem, it will be easy to
block that css out, and have login_base.html override the block.

Ideally, I would have liked to create a new api_base.html that extends
base.html, move the api specific logic into that template, and leave
base.html content agnostic, to truely be a unifying base for all DRF
pages.  But this change would break current apps that override
api.html and expect base.html to be the immediate super template. :/

This change is benificial because it:
 - removes duplication of header declarations (mostly css includes)
 - adds a html title to the login page
 - standardizes html header info across all DRF pages

Docs are updated to reflect the new structure.
2014-06-13 22:26:00 -07:00
Tai Lee
a9dbd46c94 Refs #1109 -- Update docs. Integrate changes from feedback. 2013-09-14 00:54:44 +10:00
leandersikma
56d19dcc1c Wrong name of the login_base html file.
Changed rest_framework/base_login.html to rest_framework/login_base.html (which is the correct name the user should extends in their templates).
2013-07-30 11:26:17 +02:00
Steve
61a242e27b added script block to list of blocks
Phew, was afraid I wouldn't be able to overwrite this section..
2013-07-23 10:40:54 -04:00
Tom Christie
77364d2b84 Add screenshot, and tweak docs 2013-07-09 14:00:53 +01:00
Sebastien Beal
997a93ac2e Add info about autocomplete widgets for browsable API 2013-07-07 19:04:47 +09:00
Tom Christie
a55a293450 Improve browsable API docs including theme screenshots 2013-07-03 13:02:32 +01:00
Stephan Groß
7a570e16e9 Fix md formatting and typos 2013-05-28 17:13:12 +02:00
Mark McArdle
72bc5a3556 documentation for https://github.com/tomchristie/django-rest-framework/issues/775 2013-05-18 13:19:13 +01:00
Matt Majewski
f7fdcd55e4 Update browsable-api.md
Add login template docs
2013-04-17 12:27:48 -03:00
Tom Christie
4788c87b76 Fix mismatch between template blocks and docs.
Fixes #639.
2013-02-06 12:35:05 +00:00
Tom Christie
7a89d7a770 Work on docs 2012-10-14 20:46:38 +01:00
Tom Christie
b3477b3b6c Docs tweaks 2012-10-13 15:34:38 +01:00
Tom Christie
4b691c4027 Change package name: djangorestframework -> rest_framework 2012-09-20 13:06:27 +01:00
Alec Perkins
4cbc53a75d Whoops, forgot to explain these. 2012-09-09 17:27:24 -04:00
Alec Perkins
9684b3fe22 Reference-style links. Much cleaner. 2012-09-09 17:07:54 -04:00
Alec Perkins
60e6bba12b Browsable API doc topic 2012-09-09 17:02:19 -04:00