Skip to content

Commit 2e5af06

Browse files
author
Release Manager
committed
Trac #33833: Make furo sage standard doc theme
In #33601, the furo theme has been introduced for the documentation. The aim of this ticket is to make it the standard theme. Before it happens, the remaining issues need to be fixed: - Index page in double columns look awful -- fixed in #34265 - sage logo in the side bar should link to the top of the Sage manuals - fixed in #34252 - no link to the doc root - fixed in #34267 - search page not working - fixed in #34252 - "ERROR: Adding a table of contents in Furo-based documentation is unnecessary" - https://73e5aa3fbbec2d751a47064c14479fc0d55c3de9 --sagemath-tobias.netlify.app/installation/source.html#installation-in-a -multiuser-environment - fixed in #34262 To support this ticket, the standard Furo package was accepted by the voting done in - https://groups.google.com/g/sage-devel/c/VTU_I-ecPlA along with subsidiary votings in - https://groups.google.com/g/sage-devel/c/eRh16v5Mz0c - https://groups.google.com/g/sage-devel/c/rhPECxe128o Other possible improvements: - Install sphinx-hoverxref, sphinx-notfound-page (see setuptools documentation, which also uses furo - https://setuptools.pypa.io/en/latest/history.html#documentation-changes) URL: https://trac.sagemath.org/33833 Reported by: gh-tobiasdiez Ticket author(s): Kwankyu Lee, Matthias Koeppe Reviewer(s): Matthias Koeppe, Kwankyu Lee
2 parents 97dacf8 + 1f03957 commit 2e5af06

File tree

8 files changed

+18
-10
lines changed

8 files changed

+18
-10
lines changed

.github/workflows/doc-build.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ jobs:
2424
# Reuse built SAGE_LOCAL contained in the Docker image
2525
./bootstrap
2626
./configure --enable-build-as-root --prefix=/sage/local --with-sage-venv --enable-download-from-upstream-url
27-
make furo
2827
2928
- name: Build
3029
run: make doc-html

build/pkgs/configure/checksums.ini

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
tarball=configure-VERSION.tar.gz
2-
sha1=c44fe4052d0d6ba38b7e60b82fa757fe40290433
3-
md5=bd8ae7f5adee5ff7baea95f143c5f857
4-
cksum=371288794
2+
sha1=23560f10767addedb5a1427d8d5edaf01ef1f31c
3+
md5=ff94d32b21e117d264e4cf5ba47834f0
4+
cksum=4110255875
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
6da95c029d7e1c153af30f8f2f19396efcf7e199
1+
fcc25ebf82c72cfe50e2b305deb55595e1537de8

build/pkgs/furo/type

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
optional
1+
standard

build/pkgs/sagemath_doc_html/dependencies

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
sagelib sphinx pplpy_doc | $(SAGERUNTIME) maxima networkx scipy sympy matplotlib pillow mathjax mpmath ipykernel jupyter_client conway_polynomials tachyon jmol ipywidgets jupyter_sphinx sage_docbuild elliptic_curves
1+
sagelib sphinx pplpy_doc | $(SAGERUNTIME) maxima networkx scipy sympy matplotlib pillow mathjax mpmath ipykernel jupyter_client conway_polynomials tachyon jmol ipywidgets jupyter_sphinx sage_docbuild elliptic_curves furo
22

33
# Building the documentation has many dependencies, because all
44
# documented modules are imported and because we use matplotlib to

configure.ac

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ AC_ARG_ENABLE([doc],
489489
AS_HELP_STRING([--disable-doc],
490490
[disable build of the Sage documentation and packages depending on it]), [
491491
dnl Disable packages needed for docbuilding
492-
for pkg in sage_docbuild alabaster babel snowballstemmer imagesize sphinx sphinxcontrib_devhelp sphinxcontrib_jsmath sphinxcontrib_serializinghtml sphinxcontrib_applehelp sphinxcontrib_htmlhelp sphinxcontrib_qthelp sphinxcontrib_websupport jupyter_sphinx; do
492+
for pkg in sage_docbuild alabaster babel snowballstemmer imagesize sphinx sphinxcontrib_devhelp sphinxcontrib_jsmath sphinxcontrib_serializinghtml sphinxcontrib_applehelp sphinxcontrib_htmlhelp sphinxcontrib_qthelp sphinxcontrib_websupport jupyter_sphinx furo; do
493493
AS_VAR_SET([SAGE_ENABLE_$pkg], [$enableval])
494494
done
495495
AS_VAR_IF([enableval], [no], [dnl Disable the docbuild by disabling the install tree for documentation

src/doc/common/static/custom-furo.css

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,12 @@ span.sidebar-brand-text {
22
font-size: small;
33
text-align: center;
44
}
5+
6+
div.highlight {
7+
background: #F4F4F4;
8+
}
9+
10+
body[data-theme="dark"] div.highlight {
11+
background: #383838;
12+
}
13+

src/sage_docbuild/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -260,15 +260,15 @@ def set_intersphinx_mappings(app, config):
260260

261261
# The name of the Pygments (syntax highlighting) style to use. This
262262
# overrides a HTML theme's corresponding setting.
263-
pygments_style = "tango"
263+
pygments_style = "sphinx"
264264
pygments_dark_style = "monokai"
265265

266266
# Add siderbar/home.html to the default sidebar.
267267
html_sidebars = {
268268
"**": [
269+
"sidebar/scroll-start.html",
269270
"sidebar/brand.html",
270271
"sidebar/search.html",
271-
"sidebar/scroll-start.html",
272272
"sidebar/home.html",
273273
"sidebar/navigation.html",
274274
"sidebar/ethical-ads.html",

0 commit comments

Comments
 (0)