Sage's manuals are written in ReST (reStructuredText), and generated with the software Sphinx:
| Name | Files |
|---|---|
| Tutorial | :sage_root:`src/doc/en/tutorial` |
| Developer's guide | :sage_root:`src/doc/en/developer` |
| Constructions | :sage_root:`src/doc/en/constructions` |
| Installation guide | :sage_root:`src/doc/en/installation` |
| Reference manual | :sage_root:`src/doc/en/reference` (most of it is generated from the source code) |
- Additionally, more specialized manuals can be found under :sage_root:`src/doc/en`.
- Some documents have been translated into other languages. In order to
access them, change
en/intofr/,es/,de/... See :ref:`section-manuals-names`.
After modifying some files in the Sage tutorial (:sage_root:`src/doc/en/tutorial/`), you will want to visualize the result. In order to build a html version of this document, type:
sage --docbuild tutorial htmlYou can now open :file:`SAGE_ROOT/local/share/doc/sage/html/en/tutorial/index.html` in your web browser.
- Do you want to add a new file to the documentation? :ref:`Click here <section-add-file>`.
- For more detailed information on the
--docbuildcommand, see :ref:`section-building-manuals`.
Run doctests: All files must pass tests. After modifying a document
(e.g. tutorial), you can run tests with the following command (see
:ref:`chapter-testing`):
sage -tp SAGE_ROOT/src/doc/en/tutorial/Reference manual: as this manual is mostly generated from Sage's source code, you will need to build Sage in order to see the changes you made to some function's documentation. Type:
sage -b && sage --docbuild reference htmlThe documentation can contain links toward modules, classes, or methods, e.g.:
:mod:`link to a module <sage.module_name>`
:mod:`sage.module_name` (here the link's text is the module's name)For links toward classes, methods, or functions, replace :mod: by
:class:, :meth:, or :func:, respectively. See Sphinx' documentation
on cross-referencing Python objects
and for the general syntax of
roles.
Short links: the link :func:`~sage.mod1.mod2.mod3.func1` is equivalent
to :func:`func1 <sage.mod1.mod2.mod3.func1>`: the function's name will be
used as the link name, instead of its full path.
Local names: links between methods of the same class do not need to be
absolute. If you are documenting method_one, you can write
:meth:`method_two`.
Intersphinx references: in the same way, you can refer to the modules, classes, methods, functions of the Python standard library and of several Python packages used by SageMath; see the Intersphinx documentation for details. Likewise, you can refer to the C functions of the :ref:`FLINT <spkg_flint>` library; see Sphinx' documentation on cross-referencing C constructs for more information.
To see the available cross references in any of these libraries, you can use the command
./sage -python -m sphinx.ext.intersphinx src/doc/common/_vendor/numpy.inv.
Global namespace: if an object (e.g. integral) is automatically imported
by Sage, you can link toward it without specifying its full path:
:func:`A link toward the integral function <integral>`Sage-specific roles: Sage defines several specific roles:
http links: copy/pasting a http link in the documentation works. If you want
a specific link name, use `link name <http://www.example.com>`_
Anonymous hyperlinks: Using a single underscore creates an explicit target
name "link name" which needs to be unique in the current page. Using the
same target name twice in the same page creates an error while building the
documentation saying WARNING: Duplicate explicit target name: .... To
avoid this issue, one can change the target names to be all different or
another option is to use anonymous hyperlinks with two underscores, as in
see `this page <http://www.example.com>`__ or `this page
<http://www.example2.com>`__.
Broken links: Sphinx can report broken links. See :ref:`section-building-manuals`.
If you added a new file to Sage (e.g. sage/matroids/my_algorithm.py) and you
want its content to appear in the reference manual, you have to add its name to
the file :sage_root:`src/doc/en/reference/matroids/index.rst`. Replace
'matroids' with whatever fits your case.
The combinat/ folder: if your new file belongs to a subdirectory of combinat/ the procedure is different:
- Add your file to the index stored in the
__init__.pyfile located in the directory that contains your file. - Add your file to the index contained in :sage_root:`src/doc/en/reference/combinat/module_list.rst`.
For every dynamically detectable feature such as :class:`graphviz
<~sage.features.graphviz.Graphviz>` or :class:`sage.symbolic
<sage.features.sagemath.sage__symbolic>` (see :mod:`sage.features`),
Sage defines a Sphinx tag that can be used with the Sphinx
directive ".. ONLY::".
Because Sphinx tags have to use Python identifier syntax, Sage uses
the format feature_, followed by the feature name where dots are
replaced by underscores. Hence, conditionalizing on the features of
the previous examples would look as follows:
.. ONLY:: feature_graphvizand:
.. ONLY:: feature_sage_symbolic(Do you want to edit the documentation? :ref:`Click here <section-manuals-edit>`)
All of the Sage manuals are built using the sage --docbuild
script. The content of the sage --docbuild script is defined in
:sage_root:`src/sage_docbuild/__init__.py`. It is a thin wrapper around
the sphinx-build script which does all of the real work. It is
designed to be a replacement for the default Makefiles generated by
the sphinx-quickstart script. The general form of the command
is:
sage --docbuild <document-name> <format>For example:
sage --docbuild reference htmlTwo help commands which give plenty of documentation for the sage
--docbuild script:
sage --docbuild -h # short help message
sage --docbuild -H # a more comprehensive oneOutput formats: All output formats supported by Sphinx (e.g. pdf) can be used in Sage. See http://www.sphinx-doc.org/builders.html.
Broken links: in order to build the documentation while reporting the broken
links that it contains, use the --warn-links flag. Note that Sphinx will not
rebuild a document that has not been updated, and thus not report its broken
links:
sage --docbuild --warn-links reference htmlThe <document-name> has the form:
lang/name
where lang is a two-letter language code, and name is the
descriptive name of the document. If the language is not specified,
then it defaults to English (en). The following two commands do
the exact same thing:
sage --docbuild tutorial html
sage --docbuild en/tutorial htmlTo specify the French version of the tutorial, you would simply run:
sage --docbuild fr/tutorial htmlIf you want to write :ref:`Cython <chapter-cython>` code in a ReST file, precede
the code block by .. CODE-BLOCK:: cython instead of the usual ::. Enable
syntax-highlighting in a whole file with .. HIGHLIGHT:: cython. Example:
cdef extern from "descrobject.h":
ctypedef struct PyMethodDef:
void *ml_meth
ctypedef struct PyMethodDescrObject:
PyMethodDef *d_method
void* PyCFunction_GET_FUNCTION(object)
bint PyCFunction_Check(object)