Skip to content

Commit

Permalink
Mobile friendly documentation (#543)
Browse files Browse the repository at this point in the history
* Add sphinx-rtd-theme to docs
  • Loading branch information
dancergraham authored Dec 30, 2024
1 parent 7f0d532 commit 393e7db
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/python-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install sphinx
python -m pip install .[docs]
- name: Build docs
run: |
sphinx-build -b html docs docs/_build
Expand Down
7 changes: 4 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ sphinx:
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt
python:
install:
- sphinx
- sphinx-rtd-theme
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'nature'
html_theme = "sphinx_rtd_theme"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ classifiers = [
requires-python = ">=3.8"
dependencies = ["django>=4.2"]
[project.optional-dependencies]
docs = ["sphinx"]
docs = ["sphinx", "sphinx-rtd-theme"]

[project.urls]
Homepage = "http://github.com/django-waffle/django-waffle"
Expand Down

0 comments on commit 393e7db

Please sign in to comment.