Skip to content

Commit

Permalink
Trac #33601: Documentation: Add 'furo' theme
Browse files Browse the repository at this point in the history
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
Release Manager committed May 28, 2022
2 parents a340bda + aec8fec commit c2ca6af
Show file tree
Hide file tree
Showing 9 changed files with 71 additions and 1,009 deletions.
1 change: 1 addition & 0 deletions .github/workflows/doc-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ jobs:
# Reuse built SAGE_LOCAL contained in the Docker image
./bootstrap
./configure --enable-build-as-root --prefix=/sage/local --with-sage-venv --enable-download-from-upstream-url
make furo
- name: Build
run: make doc-html
Expand Down
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
],
"python.testing.unittestEnabled": false,
"cSpell.words": [
"furo"
"Conda",
"Cython"
],
Expand Down
16 changes: 16 additions & 0 deletions build/pkgs/furo/SPKG.rst
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/

9 changes: 9 additions & 0 deletions build/pkgs/furo/dependencies
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",
1 change: 1 addition & 0 deletions build/pkgs/furo/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
furo
1 change: 1 addition & 0 deletions build/pkgs/furo/type
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
optional
9 changes: 0 additions & 9 deletions build/pkgs/mathjax/SPKG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ License

Apache License, version 2.0


Upstream Contact
----------------

Expand All @@ -22,16 +21,8 @@ Home page: https://www.mathjax.org/
Dependencies
------------

None.


Special Update/Build Instructions
---------------------------------

None.


Patches
-------

None.
Loading

0 comments on commit c2ca6af

Please sign in to comment.