Sphinx extension demo¶
This page illustrates some of the features provided by the Sphinx extension for writing documentation in the Sage’s official documentation style:
Cross-references to Sage’s official documentation:
- Welcome to the Sage Thematic Tutorials!
- Introduction to combinatorics in Sage
sage.functions.other.binomial()
Cross-references to Python’s official documentation:
- Command Reference
os
slice()
Code blocks:
Assuming internet access, the page can be activated, making the following code blocks into live cells that can be modified and evaluated:
sage: 1 + 1 2 sage: y = 1 sage: z = 2 sage: y + z 3
LaTeX output:
sage: %display latex sage: factor(x^100 - 1) (x - 1)*(x + 1)*(x^2 + 1)*(x^4 - x^3 + x^2 - x + 1)*(x^4 + x^3 + x^2 + x + 1)*(x^8 - x^6 + x^4 - x^2 + 1)*(x^20 - x^15 + x^10 - x^5 + 1)*(x^20 + x^15 + x^10 + x^5 + 1)*(x^40 - x^30 + x^20 - x^10 + 1)
Plots:
sage: plot(sin(x))
3D plots are functional with the
threejs
backend:sage: x,y = SR.var('x,y') sage: plot3d(x^2 + y^2, (x,-2,2), (y,-2,2), viewer='threejs', online=True)
but not yet with the default
jmol
backend:sage: plot3d(x^2 + y^2, (x,-2,2), (y,-2,2))
Interacts (non functional yet):
sage: @interact ....: def f(n=31): ....: return factor(n)
Plain code blocks (i.e. not containing a sage prompt) are not affected:
> sage --notebook jupyter
TODO’s:
Todo
Fix the failing cross-references above!
Mathematics:
- \(\frac{\pi}{1+10^4}\)
- Usual Sage macros \(\NN\), \(\ZZ\), \(\QQ\), \(\ZZ\)
Miscellaneous roles: