-
-
Notifications
You must be signed in to change notification settings - Fork 553
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Trac #33601: Documentation: Add 'furo' theme
As discussed in https://trac.sagemath.org/ticket/33309#comment:28, we add Furo (https://pradyunsg.me/furo/) as a possible theme for the documentation. After gaining some experience with it, the goal would be to make it the default theme for sage's docs. To test, run {{{ make furo make doc-clean; make doc-uninstall; make }}} To go back to the classic sage theme, uninstall furo using `./sage -pip uninstall furo`. Known issues (to be fixed as follow-ups/upstream): - Reference manual index page and many sub-pagaes don't have a table of contents on the left https://516dfe85b21eafae4f042320e5dcf61ad14fe780 --sagemath-tobias.netlify.app/reference/ - Index page is missing/not working https://516dfe85b21eafae4f042320e5dcf61ad14fe780--sagemath- tobias.netlify.app/ - sage logo in the side bar should link to the top of the Sage manuals URL: https://trac.sagemath.org/33601 Reported by: gh-tobiasdiez Ticket author(s): Tobias Diez Reviewer(s): Kwankyu Lee
- Loading branch information
Showing
9 changed files
with
71 additions
and
1,009 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,6 +22,7 @@ | |
], | ||
"python.testing.unittestEnabled": false, | ||
"cSpell.words": [ | ||
"furo" | ||
"Conda", | ||
"Cython" | ||
], | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
furo: A clean customizable Sphinx documentation theme | ||
===================================================== | ||
|
||
Description | ||
----------- | ||
|
||
A clean customizable Sphinx documentation theme. | ||
|
||
License | ||
------- | ||
|
||
Upstream Contact | ||
---------------- | ||
|
||
https://pypi.org/project/furo/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
$(PYTHON) beautifulsoup4 sphinx pygments | $(PYTHON_TOOLCHAIN) | ||
|
||
---------- | ||
All lines of this file are ignored except the first. | ||
|
||
From https://github.com/pradyunsg/furo/blob/b4c8010cff5e494a93d617069897964c60b820e9/pyproject.toml#L18-L22 | ||
"beautifulsoup4", | ||
"sphinx ~= 4.0", | ||
"pygments ~= 2.7", |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
furo |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
optional |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.