Skip to content

Make Sage documentation functional #33309

@kwankyu

Description

@kwankyu

Sage documentation (website) is currently buggy in many ways.

I tried to fix various defects I noticed, including

  • links in navigation bar
  • index page, which is now in single column
  • sage logo link always goes to the sagemath homepage
  • class names now look ragged right
  • long Bases for classes now horizontally scrolled
  • updated sage theme based on the latest classic theme of Sphinx
  • renamed sage theme to sage-classic theme (in anticipation of alternative themes)
  • remove unnecessary sageref theme; only use sage theme
  • remove obsolete python2.inv hyperlinks database
  • added a new index.html which is installed right into the root directory SAGE_DOC.
  • adjusted colors to increase contrast among elements
  • documentation access from jupyter notebook (this undoes PDF documentation links in Documentation from Jupyter notebook are broken #33206)
  • search box works (turned off Thebe)

As noted in the last item above, I turned off Thebe here. Work on reviving Thebe will continue in #33320 (perhaps very slowly).

To cleanly build the new documentation, try

$ make doc-uninstall && make doc-html && make doc-pdf

CC: @strogdon @haraldschilly @mkoeppe

Component: documentation

Author: Kwankyu Lee

Branch: acecf84

Reviewer: Tobias Diez, John Palmieri, François Bissey, Steven Trogdon

Issue created by migration from https://trac.sagemath.org/ticket/33309

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions