django-rest-framework/.readthedocs.yaml
Bruno Alla 190aae3c2d
Switch to mkdocs material theme for documentation (#9849)
* Switch to mkdocs material theme

* Add logo

* Style badges on homepage

* Basic dark theme

* Enable a few theme features

* Customise large logo for dark theme

* CSS tweaks

* Add background grid back

* Switch to mkdocs material theme

* Add logo

* Style badges on homepage

* Basic dark theme

* Add syntax highlighting to code snippets

* Convert homepage snippets to code fences

* Update homepage logos

* Move mkdocs-material to pyproject.toml docs group

* Keep existing syntax highlighting

* Remove old docs_theme folder

* Tweak syntax highlighting colors on dark theme

* Add readthedocs config file

* Fix end of file empty lines

* Upgrade pip during install

* Remove custom styling for .prettyprint

* Remove .prettyprint border entirely

* Make tabs sticky in navbar

* Merge page ToC with navigation

* Tweak colors for more accessible contrast

* Add Figma file for the logos

* Apply suggestion from @Copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Adjust styles for badges

* Enable content tabs for OS specific instructions

https://squidfunk.github.io/mkdocs-material/reference/content-tabs/

* Add icons for content tabs

* Standardize on .venv for virtualenv name in docs

* Add note about bash for Windows

---------

Co-authored-by: Asif Saif Uddin {"Auvi":"অভি"} <auvipy@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-03-02 00:59:00 +06:00

20 lines
415 B
YAML

# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the OS, Python version, and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.13"
jobs:
install:
- pip install --upgrade pip
- pip install -e . --group docs
# Build documentation with Mkdocs
mkdocs:
configuration: mkdocs.yml