Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: switch to Furo #2793

Merged
merged 1 commit into from
Jan 21, 2022
Merged

Docs: switch to Furo #2793

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@
### Documentation

- Change protocol in pip installation instructions to `https://` (#2761)
- Change HTML theme to Furo primarily for its responsive design and mobile support
(#2793)

## 21.12b0

Expand Down
44 changes: 0 additions & 44 deletions docs/_static/custom.css
View file
Open in desktop

This file was deleted.

25 changes: 2 additions & 23 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,29 +115,8 @@ def make_pypi_svg(version: str) -> None:
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "alabaster"

html_sidebars = {
"**": [
"about.html",
"navigation.html",
"relations.html",
"searchbox.html",
]
}

html_theme_options = {
"show_related": False,
"description": "“Any color you like.”",
"github_button": True,
"github_user": "psf",
"github_repo": "black",
"github_type": "star",
"show_powered_by": True,
"fixed_sidebar": True,
"logo": "logo2.png",
}

html_theme = "furo"
html_logo = "_static/logo2-readme.png"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
Expand Down
1 change: 1 addition & 0 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ The most common questions and issues users face are aggregated to this FAQ.
```{contents}
:local:
:backlinks: none
:class: this-will-duplicate-information-and-it-is-still-useful-here
```

## Does Black have an API?
Expand Down
13 changes: 9 additions & 4 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
The uncompromising code formatter
=================================

“Any color you like.”

By using *Black*, you agree to cede control over minutiae of
hand-formatting. In return, *Black* gives you speed, determinism, and
freedom from `pycodestyle` nagging about formatting. You will save time
Expand Down Expand Up @@ -99,6 +101,7 @@ Contents
.. toctree::
:maxdepth: 3
:includehidden:
:caption: User Guide

getting_started
usage_and_configuration/index
Expand All @@ -107,19 +110,21 @@ Contents
faq

.. toctree::
:maxdepth: 3
:maxdepth: 2
:includehidden:
:caption: Development

contributing/index
change_log
authors

.. toctree::
:hidden:
:caption: Project Links

GitHub ↪ <https://github.com/psf/black>
PyPI ↪ <https://pypi.org/project/black>
Chat ↪ <https://discord.gg/RtVdv86PrH>
GitHub <https://github.com/psf/black>
PyPI <https://pypi.org/project/black>
Chat <https://discord.gg/RtVdv86PrH>

Indices and tables
==================
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ myst-parser==0.16.1
Sphinx==4.4.0
sphinxcontrib-programoutput==0.17
sphinx_copybutton==0.4.0
furo==2022.1.2