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

add furo theme on sphinx-themes #2005

Merged
merged 1 commit into from
Aug 14, 2023
Merged

add furo theme on sphinx-themes #2005

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
Binary file added docs/_static/img/furo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/guide/tools/sphinx-themes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Sphinx Themes

Check failure on line 1 in docs/guide/tools/sphinx-themes.rst

View workflow job for this annotation

GitHub Actions / vale-runner 

[vale] reported by reviewdog 🐶
[WTD.headings] 'Sphinx Themes' should be in sentence case

Raw Output:
{"message": "[WTD.headings] 'Sphinx Themes' should be in sentence case", "location": {"path": "docs/guide/tools/sphinx-themes.rst", "range": {"start": {"line": 1, "column": 1}}}, "severity": "ERROR"}
=============

These are the Sphinx themes that we recommend.
Expand All @@ -12,7 +12,7 @@
* Installable as a Python module
* Maintained and documented

Read the Docs Theme

Check failure on line 15 in docs/guide/tools/sphinx-themes.rst

View workflow job for this annotation

GitHub Actions / vale-runner 

[vale] reported by reviewdog 🐶
[WTD.headings] 'Read the Docs Theme' should be in sentence case

Raw Output:
{"message": "[WTD.headings] 'Read the Docs Theme' should be in sentence case", "location": {"path": "docs/guide/tools/sphinx-themes.rst", "range": {"start": {"line": 15, "column": 1}}}, "severity": "ERROR"}
-------------------

The official theme for Read the Docs.
Expand All @@ -39,7 +39,7 @@
.. image:: /_static/img/paramiko.png
:width: 80%

Sphinx Bootstrap Theme

Check failure on line 42 in docs/guide/tools/sphinx-themes.rst

View workflow job for this annotation

GitHub Actions / vale-runner 

[vale] reported by reviewdog 🐶
[WTD.headings] 'Sphinx Bootstrap Theme' should be in sentence case

Raw Output:
{"message": "[WTD.headings] 'Sphinx Bootstrap Theme' should be in sentence case", "location": {"path": "docs/guide/tools/sphinx-themes.rst", "range": {"start": {"line": 42, "column": 1}}}, "severity": "ERROR"}
----------------------

A basic Sphinx theme that uses Bootstrap for nice styling.
Expand All @@ -51,7 +51,7 @@
.. image:: /_static/img/bootstrap.png
:width: 80%

Guzzle Theme

Check failure on line 54 in docs/guide/tools/sphinx-themes.rst

View workflow job for this annotation

GitHub Actions / vale-runner 

[vale] reported by reviewdog 🐶
[WTD.headings] 'Guzzle Theme' should be in sentence case

Raw Output:
{"message": "[WTD.headings] 'Guzzle Theme' should be in sentence case", "location": {"path": "docs/guide/tools/sphinx-themes.rst", "range": {"start": {"line": 54, "column": 1}}}, "severity": "ERROR"}
------------

Originally built for Guzzle (PHP HTTP client), this theme is another
Expand All @@ -62,7 +62,7 @@
.. image:: /_static/img/guzzle.png
:width: 80%

Documatt Theme

Check failure on line 65 in docs/guide/tools/sphinx-themes.rst

View workflow job for this annotation

GitHub Actions / vale-runner 

[vale] reported by reviewdog 🐶
[WTD.headings] 'Documatt Theme' should be in sentence case

Raw Output:
{"message": "[WTD.headings] 'Documatt Theme' should be in sentence case", "location": {"path": "docs/guide/tools/sphinx-themes.rst", "range": {"start": {"line": 65, "column": 1}}}, "severity": "ERROR"}
--------------

Mobile friendly Sphinx theme designed to provide great documentation reading experience with beautiful typography.
Expand All @@ -73,3 +73,14 @@

.. image:: /_static/img/documatt.png
:width: 80%

Furo Theme

Check failure on line 77 in docs/guide/tools/sphinx-themes.rst

View workflow job for this annotation

GitHub Actions / vale-runner 

[vale] reported by reviewdog 🐶
[WTD.headings] 'Furo Theme' should be in sentence case

Raw Output:
{"message": "[WTD.headings] 'Furo Theme' should be in sentence case", "location": {"path": "docs/guide/tools/sphinx-themes.rst", "range": {"start": {"line": 77, "column": 1}}}, "severity": "ERROR"}
------------

Originally built for the pip documentation, this mobile friendly theme is minimal but customizable and has carefully
designed navigation features (sidebar, inter-page links).

* https://github.com/pradyunsg/furo

.. image:: /_static/img/furo.png
:width: 80%
Loading