Documentation System
Release 10.4

The Sage Development TeamJul 23, 2024

CONTENTS

1

Sage Doc Builders

1

2

Sphinx Extensions

15

Python Module Index

29

Index

31

i

ii

CHAPTERONE

SAGE DOC BUILDERS

1.1 Sage docbuild main
This module defines the Sage documentation build command:
sage --docbuild [OPTIONS] DOCUMENT (FORMAT | COMMAND)

If FORMAT is given, it builds DOCUMENT in FORMAT. If COMMAND is given, it returns information about DOCUMENT.
Run sage --docbuild to get detailed explanations about arguments and options.
Positional arguments:
DOCUMENT

FORMAT or COMMAND

name of the document to build. It can be either one ofthe documents listed by -D or file=/path/to/FILE tobuild documentation for this specific file.
document output format (or command)

Standard options:-h, --help
show a help message and exit
-H, --help-allshow an extended help message and exit
-D, --documents
list all available DOCUMENTs-F, --formats
list all output FORMATs-C DOC, --commands DOC
list all COMMANDs for DOCUMENT DOC; use all to list all-i, --inherited
include inherited members in reference manual; may be
slow, may fail for PDF output-u, --underscore
include variables prefixed with _ in reference
manual; may be slow, may fail for PDF output-j, --mathjax, --jsmath
ignored for backwards compatibility--no-plot
do not include graphics auto-generated using the .. plot ␣˓→markup--no-preparsed-examples
do not show preparsed versions of EXAMPLES blocks--include-tests-blocks
include TESTS blocks in the reference manual--no-pdf-links
do not include PDF links in DOCUMENT website ;FORMATs: html, json, pickle, web--live-doc
make Sage code blocks live for html FORMAT--warn-links
issue a warning whenever a link is not properly
resolved; equivalent to --sphinx-opts -n (sphinx
option: nitpicky)(continues on next page)1

Documentation System, Release 10.4

(continued from previous page)--check-nested
check picklability of nested classes in DOCUMENT reference--no-prune-empty-dirs
do not prune empty directories in the documentation sources--use-cdns
assume internet connection and use CDNs; in particular,
use MathJax CDN-N, --no-colors
do not color output; does not affect children-q, --quiet
work quietly; same as --verbose=0-v LEVEL, --verbose LEVEL
report progress at LEVEL=0 (quiet), 1 (normal), 2(info), or 3 (debug); does not affect children-o DIR, --output DIR if DOCUMENT is a single file ( file=... ), write output
to this directory

Advanced options:
Use these options with care.
-S OPTS, --sphinx-opts OPTS
pass comma-separated OPTS to sphinx-build; must precede
OPTS with = , as in -S=-q,-aE or -S="-q,-aE"-U, --update-mtimes
before building reference manual, update modification
times for auto-generated reST files-k, --keep-going
Do not abort on errors but continue as much as possible
after an error--all-documents ARG
if ARG is reference , list all subdocuments ofen/reference. If ARG is all , list all main documents

class sage_docbuild.__main__.IntersphinxCache
Bases: object
Replace sphinx.ext.intersphinx.fetch_inventory by an in-memory cached version.
fetch_inventory(app, uri, inv)
Return the result of sphinx.ext.intersphinx.fetch_inventory() from a cache if possible.
Otherwise, call sphinx.ext.intersphinx.fetch_inventory() and cache the result.
sage_docbuild.__main__.format_columns(lst, align='<', cols=None, indent=4, pad=3, width=80)
Utility function that formats a list as a simple table and returns a Unicode string representation.
The number of columns is computed from the other options, unless it’s passed as a keyword argument. For help on
Python’s string formatter, see
https://docs.python.org/library/string.html#format-string-syntax
sage_docbuild.__main__.get_formats()
Return a list of output formats the Sage documentation builder will accept on the command-line.
sage_docbuild.__main__.help_commands(name='all')Append and return a tabular list of commands, if any, the Sage documentation builder can run on the indicateddocument. The default is to list all commands for all documents.
sage_docbuild.__main__.help_description(s='', compact=False)
Append and return a brief description of the Sage documentation builder.
If ‘compact’ is False, the function adds a final newline character.
sage_docbuild.__main__.help_documents()
Append and return a tabular list of documents, including a shortcut ‘all’ for all documents, available to the Sage
documentation builder.
2

Chapter 1. Sage Doc Builders

Documentation System, Release 10.4

sage_docbuild.__main__.help_examples(s='')Append and return some usage examples for the Sage documentation builder.
sage_docbuild.__main__.help_formats()
Append and return a tabular list of output formats available to the Sage documentation builder.
class sage_docbuild.__main__.help_message_long(option_strings, dest, nargs=None, const=None,default=None, type=None, choices=None,required=False, help=None, metavar=None)
Bases: Action
Print an extended help message for the Sage documentation builder and exits.
class sage_docbuild.__main__.help_message_short(option_strings, dest, nargs=None, const=None,default=None, type=None, choices=None,required=False, help=None, metavar=None)
Bases: Action
Print a help message for the Sage documentation builder.
The message includes command-line usage and a list of options. The message is printed only on the first call. If
error is True during this call, the message is printed only if the user hasn’t requested a list (e.g., documents, formats,commands).
sage_docbuild.__main__.help_usage(s='', compact=False)
Append and return a brief usage message for the Sage documentation builder.
If ‘compact’ is False, the function adds a final newline character.
class sage_docbuild.__main__.help_wrapper(option_strings, dest, nargs=None, const=None,default=None, type=None, choices=None,required=False, help=None, metavar=None)
Bases: Action
A helper wrapper for command-line options to the Sage documentation builder that print lists, such as document
names, formats, and document-specific commands.
sage_docbuild.__main__.main()
sage_docbuild.__main__.setup_logger(verbose=1, color=True)
Set up a Python Logger instance for the Sage documentation builder.
The optional argument sets logger’s level and message format.
EXAMPLES:
sage: from sage_docbuild.__main__ import setup_logger, logger
sage: setup_logger()sage: type(logger)<class logging.Logger >>>> from sage.all import *>>> from sage_docbuild.__main__ import setup_logger, logger>>> setup_logger()>>> type(logger)<class logging.Logger >sage_docbuild.__main__.setup_parser()
Set up and return a command-line ArgumentParser instance for the Sage documentation builder.
1.1. Sage docbuild main3Documentation System, Release 10.4

1.2 Documentation builders
This module is the starting point for building documentation, and is responsible to figure out what to build and with which
options. The actual documentation build for each individual document is then done in a subprocess call to Sphinx, seebuilder_helper(). Note that
• The builders are configured with build_options.py;• The Sphinx subprocesses are configured in conf.py.
DocBuilder is the base class of all Builders. It has builder helpers html(), latex(), pdf(), inventory(),etc, which are invoked depending on the output type. Each type corresponds with the Sphinx builder format, exceptthat pdf is Sphinx latex builder plus compiling latex to pdf. Note that Sphinx inventory builder is not native to Sphinx
but provided by Sage. See sage_docbuild/ext/inventory_builder.py. The Sphinx inventory builder is adummy builder with no actual output but produces doctree files in local/share/doctree and inventory.inv
inventory files in local/share/inventory.
The reference manual is built in two passes, first by ReferenceBuilder with inventory output type and secondly
with``html`` output type. The ReferenceBuilder itself uses ReferenceTopBuilder and ReferenceSubBuilder to build subcomponents of the reference manual. The ReferenceSubBuilder examines the modules
included in the subcomponent by comparing the modification times of the module files with the times saved in local/
share/doctree/reference.pickle from the previous build. Then new rst files are generated for new andupdated modules. See get_new_and_updated_modules().
After Issue #31948, when Sage is built, ReferenceBuilder is not used and its responsibility is now taken by the
Makefile in $SAGE_ROOT/src/doc.
class sage_docbuild.builders.AllBuilder
Bases: object
A class used to build all of the documentation.
get_all_documents()
Return a list of all of the documents.
A document is a directory within one of the language subdirectories of SAGE_DOC_SRC specified by the
global LANGUAGES variable.
EXAMPLES:
sage: from sage_docbuild.builders import AllBuilder
sage: documents = AllBuilder().get_all_documents()
sage: en/tutorial in documents # optional - sage_spkg
True
sage: documents[0] == en/reference
True>>> from sage.all import *>>> from sage_docbuild.builders import AllBuilder>>> documents = AllBuilder().get_all_documents()>>> en/tutorial in documents # optional - sage_spkg
True>>> documents[Integer(0)] == en/reference
Trueclass sage_docbuild.builders.DocBuilder(name, lang='en')
Bases: object
INPUT:
4

Chapter 1. Sage Doc Builders

Documentation System, Release 10.4

• name – the name of a subdirectory in SAGE_DOC_SRC, such as ‘tutorial’ or ‘bordeaux_2008’• lang – (default “en”) the language of the document.
changes(*args, **kwds)
clean(*args)
html(*args, **kwds)
htmlhelp(*args, **kwds)
inventory(*args, **kwds)
json(*args, **kwds)
latex(*args, **kwds)
linkcheck(*args, **kwds)
pdf()
Build the PDF files for this document.
This is done by first (re)-building the LaTeX output, going into that LaTeX directory, and running ‘makeall-pdf’ there.
EXAMPLES:
sage: from sage_docbuild.builders import DocBuilder
sage: b = DocBuilder( tutorial )sage: b.pdf() #not tested>>> from sage.all import *>>> from sage_docbuild.builders import DocBuilder>>> b = DocBuilder( tutorial )>>> b.pdf() #not tested

pickle(*args, **kwds)
web(*args, **kwds)
class sage_docbuild.builders.ReferenceBuilder(name, lang='en')
Bases: AllBuilder
This class builds the reference manual. It uses DocBuilder to build the top-level page and ReferenceSubBuilder foreach sub-component.
get_all_documents(refdir)
Return a list of all reference manual components to build.
We add a component name if it’s a subdirectory of the manual’s directory and contains a file named ‘index.rst’.
We return the largest component (most subdirectory entries) first since they will take the longest to build.
EXAMPLES:
sage: from sage_docbuild.builders import ReferenceBuilder
sage: b = ReferenceBuilder( reference )sage: refdir = os.path.join(os.environ[ SAGE_DOC_SRC ], en , b.name)
˓→optional - sage_spkg
sage: sorted(b.get_all_documents(refdir)) # optional - sage_spkg#␣(continues on next page)1.2. Documentation builders

5Documentation System, Release 10.4

(continued from previous page)[ reference/algebras ,reference/arithgroup ,...,reference/valuations ]>>> from sage.all import *>>> from sage_docbuild.builders import ReferenceBuilder>>> b = ReferenceBuilder( reference )>>> refdir = os.path.join(os.environ[ SAGE_DOC_SRC ], en , b.name)
˓→optional - sage_spkg>>> sorted(b.get_all_documents(refdir)) # optional - sage_spkg[ reference/algebras ,reference/arithgroup ,...,reference/valuations ]#␣class sage_docbuild.builders.ReferenceSubBuilder(*args, **kwds)
Bases: DocBuilder
This class builds sub-components of the reference manual. It is responsible for making sure that the auto generated
reST files for the Sage library are up to date.
When building any output, we must first go through and check to see if we need to update any of the autogenerated
reST files. There are two cases where this would happen:
1. A new module gets added to one of the toctrees.
2. The actual module gets updated and possibly contains a new title.
auto_rest_filename(module_name)Return the name of the file associated to a given module
EXAMPLES:
sage: from sage_docbuild.builders import ReferenceSubBuilder
sage: ReferenceSubBuilder("reference").auto_rest_filename("sage.combinat.
˓→partition").../en/reference/sage/combinat/partition.rst>>> from sage.all import *>>> from sage_docbuild.builders import ReferenceSubBuilder>>> ReferenceSubBuilder("reference").auto_rest_filename("sage.combinat.
˓→partition").../en/reference/sage/combinat/partition.rst

cache_filename()
Return the filename where the pickle of the reference cache is stored.
clean_auto()
Remove all autogenerated reST files.
get_all_included_modules()Return an iterator for all modules which are included in the reference manual.
get_all_rst_files(exclude_sage=True)
Return an iterator for all rst files which are not autogenerated.

6

Chapter 1. Sage Doc Builders

Documentation System, Release 10.4

get_cache()
Retrieve the reference cache which contains the options previously used by the reference builder.
If it doesn’t exist, then we just return an empty dictionary. If it is corrupted, return an empty dictionary.
get_modified_modules()Return an iterator for all the modules that have been modified since the documentation was last built.
get_module_docstring_title(module_name)Return the title of the module from its docstring.
get_modules(filename)
Given a filename for a reST file, return an iterator for all of the autogenerated reST files that it includes.
get_new_and_updated_modules()Return an iterator for all new and updated modules that appear in the toctrees, and remove obsolete oldmodules.
get_sphinx_environment()
Return the Sphinx environment for this project.
get_unincluded_modules()Return an iterator for all the modules in the Sage library which are not included in the reference manual.
print_included_modules()Print all of the modules that are included in the Sage reference manual.
print_modified_modules()Print a list of all the modules that have been modified since the documentation was last built.
print_new_and_updated_modules()Print all the modules that appear in the toctrees that are newly included or updated.
print_unincluded_modules()Print all of the modules which are not included in the Sage reference manual.
save_cache()
Pickle the current reference cache for later retrieval.
update_mtimes()
Update the modification times for reST files in the Sphinx environment for this project.
write_auto_rest_file(module_name)Write the autogenerated reST file for module_name.
class sage_docbuild.builders.ReferenceTopBuilder(*args, **kwds)
Bases: DocBuilder
This class builds the top-level page of the reference manual.
html()
Build the top-level document.
class sage_docbuild.builders.SingleFileBuilder(path)
Bases: DocBuilder
This is the class used to build the documentation for a single user-specified file. If the file is called ‘foo.py’, thenthe documentation is built in DIR/foo/ if the user passes the command line option “-o DIR”, or in DOT_SAGE/
docbuild/foo/ otherwise.

1.2. Documentation builders

7Documentation System, Release 10.4class sage_docbuild.builders.WebsiteBuilder(name, lang='en')
Bases: DocBuilder
clean()
When we clean the output for the website index, we need to remove all of the HTML that were placed in theparent directory.
In addition, remove the index file installed into the root doc directory.
html()
After we have finished building the website index page, we copy everything one directory up, that is, to thebase diectory html/en.
In addition, an index file is installed into the root doc directory.
Thus we have three index.html files:
html/en/website/index.html (not used) html/en/index.html (base directory) index.html (root doc directory)
pdf()
Build the website hosting pdf docs.
sage_docbuild.builders.build_many(target, args, processes=None)
Thin wrapper around 𝑠𝑎𝑔𝑒𝑑 𝑜𝑐𝑏𝑢𝑖𝑙𝑑.𝑢𝑡𝑖𝑙𝑠.𝑏𝑢𝑖𝑙𝑑𝑚 𝑎𝑛𝑦 which uses the docbuild settings NUM_THREADS andABORT_ON_ERROR.
sage_docbuild.builders.build_other_doc(args)
sage_docbuild.builders.build_ref_doc(args)
sage_docbuild.builders.builder_helper(type)
Return a function which builds the documentation for output type type.
sage_docbuild.builders.get_builder(name)Return an appropriate Builder object for the document name.
DocBuilder and its subclasses do all the real work in building the documentation.
sage_docbuild.builders.get_documents()
Return a list of document names the Sage documentation builder will accept as command-line arguments.

1.3 Build options
This module defines options for building Sage documentation.

1.4 Sphinx build script
This is Sage’s version of the sphinx-build script. We redirect stdout and stderr to our own logger, and remove
some unwanted chatter.
class sage_docbuild.sphinxbuild.SageSphinxLogger(stream, prefix)
Bases: object
This implements the file object interface to serve as sys.stdout/sys.stderr replacement.

8

Chapter 1. Sage Doc Builders

Documentation System, Release 10.4

ansi_escape_sequence = re.compile( \n \\x1b # ESC\n \\[ # CSI sequence
starts\n [0-?]* # parameter bytes\n [ -/]* # intermediate bytes\n [@-~] #final byte\n , re.VERBOSE)
ansi_escape_sequence_color = re.compile( \n \\x1b # ESC\n \\[ # CSIsequence starts\n [0-9;]* # parameter bytes\n # intermediate bytes\n m #final byte\n , re.VERBOSE)
close()
closed = False
encoding = None
flush()
isatty()mode =

wname =<log>

newlines = Noneprefix_len = 9
raise_errors()
Raise an exceptions if any errors have been found while parsing the Sphinx output.
EXAMPLES:
sage: from sys import stdout
sage: from sage_docbuild.sphinxbuild import SageSphinxLogger
sage: logger = SageSphinxLogger(stdout, "doctesting")sage: logger._log_line("This is a SEVERE error\n")[doctestin] This is a SEVERE error
sage: logger.raise_errors()
Traceback (most recent call last):...
OSError: This is a SEVERE error>>> from sage.all import *>>> from sys import stdout>>> from sage_docbuild.sphinxbuild import SageSphinxLogger>>> logger = SageSphinxLogger(stdout, "doctesting")>>> logger._log_line("This is a SEVERE error\n")[doctestin] This is a SEVERE error>>> logger.raise_errors()
Traceback (most recent call last):...
OSError: This is a SEVERE error

softspace = 0
write(str)writelines(sequence)

1.4. Sphinx build script9Documentation System, Release 10.4

sage_docbuild.sphinxbuild.runsphinx()
sage_docbuild.sphinxbuild.term_width_line(text)

1.5 Sphinx build configuration
This file contains configuration needed to customize Sphinx input and output behavior.
class sage_docbuild.conf.SagecodeTransform(document, startnode=None)
Bases: SphinxTransform
Transform a code block to a live code block enabled by jupyter-sphinx.
Effectively a code block like:
EXAMPLE::sage: 1 + 1
2

is transformed into:
EXAMPLE::sage: 1 + 1
2.. ONLY:: html.. JUPYTER-EXECUTE:::hide-code::hide-output::raises::stderr:
1 + 1

enabling live execution of the code.
apply()
default_priority = 170
Numerical priority of this transform, 0 through 999 (override).
class sage_docbuild.conf.Tags
Bases: sethas(*args, **kwds)
x.__contains__(y) <==> y in x.
sage_docbuild.conf.add_page_context(app, pagename, templatename, context, doctree)
sage_docbuild.conf.call_intersphinx(app, env, node, contnode)Call intersphinx and make links between Sage manuals relative.
sage_docbuild.conf.check_nested_class_picklability(app, what, name, obj, skip, options)
Print a warning if pickling is broken for nested classes.

10

Chapter 1. Sage Doc Builders

Documentation System, Release 10.4

sage_docbuild.conf.debug_inf(app, message)
sage_docbuild.conf.find_sage_dangling_links(app, env, node, contnode)
Try to find dangling link in local module imports or all.py.
sage_docbuild.conf.linkcode_resolve(domain, info)
sage_docbuild.conf.set_intersphinx_mappings(app, config)
Add precompiled inventory (the objects.inv)
sage_docbuild.conf.setup(app)sage_docbuild.conf.skip_member(app, what, name, obj, skip, options)
To suppress Sphinx warnings / errors, we• Don’t include [aliases of] builtins.
• Don’t include the docstring for any nested class which has been inserted into its module by sage.misc.
NestedClassMetaclass only for pickling. The class will be properly documented inside its surroundingclass.
• Optionally, check whether pickling is broken for nested classes.
• Optionally, include objects whose name begins with an underscore (‘_’), i.e., “private” or “hidden” attributes,
methods, etc.
Otherwise, we abide by Sphinx’s decision. Note: The object obj is excluded (included) if this handler returns
True (False).

1.6 Utilities
exception sage_docbuild.utils.RemoteException(tb: str)
Bases: Exception
Raised if an exception occurred in one of the child processes.
tb: strclass sage_docbuild.utils.RemoteExceptionWrapper(exc: BaseException)
Bases: object
Used by child processes to capture exceptions thrown during execution and report them to the main process, including the correct traceback.
exc: BaseException
tb: strexception sage_docbuild.utils.WorkerDiedException(message: str | None, original_exception:
BaseException | None = None)
Bases: RuntimeError
Raised if a worker process dies unexpected.
original_exception: BaseException | None

1.6. Utilities

11Documentation System, Release 10.4

sage_docbuild.utils.build_many(target, args, processes=None)
Map a list of arguments in args to a single-argument target function target in parallel using
multiprocessing.cpu_count() (or processes if given) simultaneous processes.
This is a simplified version of multiprocessing.Pool.map from the Python standard library which avoids
a couple of its pitfalls. In particular, it can abort (with a RuntimeError) without hanging if one of the worker
processes unexpectedly dies. It also has semantics equivalent to maxtasksperchild=1; that is, one process
is started per argument. As such, this is inefficient for processing large numbers of fast tasks, but appropriate forrunning longer tasks (such as doc builds) which may also require significant cleanup.
It also avoids starting new processes from a pthread, which results in at least one known issue:• When PARI is built with multi-threading support, forking a Sage process from a thread leaves the main Pariinterface instance broken (see Issue #26608#comment:38).
In the future this may be replaced by a generalized version of the more robust parallel processing implementationfrom sage.doctest.forker.
EXAMPLES:
sage: from sage_docbuild.utils import build_many
sage: def target(N):....:import time....:
time.sleep(float(0.1))....:
print( Processed task %s % N)
sage: _ = build_many(target, range(8), processes=8)
Processed task ...
Processed task ...
Processed task ...
Processed task ...
Processed task ...
Processed task ...
Processed task ...
Processed task ...
>>> from sage.all import *>>> from sage_docbuild.utils import build_many>>> def target(N):...
import time...
time.sleep(float(RealNumber( 0.1 )))...
print( Processed task %s % N)>>> _ = build_many(target, range(Integer(8)), processes=Integer(8))
Processed task ...
Processed task ...
Processed task ...
Processed task ...
Processed task ...
Processed task ...
Processed task ...
Processed task ...

This version can also return a result, and thus can be used as a replacement for multiprocessing.Pool.map(i.e. it still blocks until the result is ready):
sage: def square(N):....:return N * N
sage: build_many(square, range(100))[0, 1, 4, 9, ..., 9604, 9801]

12

Chapter 1. Sage Doc Builders

Documentation System, Release 10.4>>> from sage.all import *>>> def square(N):...
return N * N>>> build_many(square, range(Integer(100)))[0, 1, 4, 9, ..., 9604, 9801]

If the target function raises an exception in any of the workers, build_many raises that exception and all otherresults are discarded. Any in-progress tasks may still be allowed to complete gracefully before the exception israised:sage: def target(N):....:import time, os, signal....:
if N == 4:....:# Task 4 is a poison pill
....:
1 / 0
....:
else:
....:
time.sleep(float(0.5))....:
print( Processed task %s % N)>>> from sage.all import *>>> def target(N):...
import time, os, signal...
if N == Integer(4):...
# Task 4 is a poison pill...
Integer(1) / Integer(0)
...
else:
...
time.sleep(float(RealNumber( 0.5 )))...
print( Processed task %s % N)

Note: In practice this test might still show output from the other worker processes before the poison-pill is executed.
It may also display the traceback from the failing process on stderr. However, due to how the doctest runner works,
the doctest will only expect the final exception:
sage: build_many(target, range(8), processes=8)Traceback (most recent call last):...
raise ZeroDivisionError("rational division by zero")
ZeroDivisionError: rational division by zero...
raise worker_exc.original_exception
ZeroDivisionError: rational division by zero>>> from sage.all import *>>> build_many(target, range(Integer(8)), processes=Integer(8))
Traceback (most recent call last):...
raise ZeroDivisionError("rational division by zero")
ZeroDivisionError: rational division by zero...
raise worker_exc.original_exception
ZeroDivisionError: rational division by zero

Similarly, if one of the worker processes dies unexpectedly otherwise exits non-zero (e.g. killed by a signal) any
in-progress tasks will be completed gracefully, but then a RuntimeError is raised and pending tasks are notstarted:1.6. Utilities

13Documentation System, Release 10.4

sage: def target(N):....:import time, os, signal....:
if N == 4:....:# Task 4 is a poison pill....:os.kill(os.getpid(), signal.SIGKILL)
....:
else:
....:
time.sleep(float(0.5))....:
print( Processed task %s % N)
sage: build_many(target, range(8), processes=8)Traceback (most recent call last):...
WorkerDiedException: worker for 4 died with non-zero exit code -9>>> from sage.all import *>>> def target(N):...
import time, os, signal...
if N == Integer(4):...
# Task 4 is a poison pill...
os.kill(os.getpid(), signal.SIGKILL)
...
else:
...
time.sleep(float(RealNumber( 0.5 )))...
print( Processed task %s % N)>>> build_many(target, range(Integer(8)), processes=Integer(8))
Traceback (most recent call last):...
WorkerDiedException: worker for 4 died with non-zero exit code -9

14

Chapter 1. Sage Doc Builders

CHAPTERTWOSPHINX EXTENSIONS

2.1 Inventory builder
A customized builder which only generates intersphinx “object.inv” inventory files. The documentation files are notwritten.
class sage_docbuild.ext.inventory_builder.InventoryBuilder(app: Sphinx, env:
BuildEnvironment)
Bases: DummyBuilder
A customized builder which only generates intersphinx “object.inv” inventory files. The documentation files are
not written.
epilog =The inventory file is in %(outdir)s.

The message emitted upon successful build completion. This can be a printf-style template string with thefollowing keys: outdir, projectfinish()Only write the inventory files.
format =inventory

The builder’s output format, or ‘’ if no document output is produced.
get_outdated_docs()
Return an iterable of output files that are outdated.
get_target_uri(docname, typ=None)
Return the target URI for a document name.
name =

inventory

The builder’s name, for the -b command line option.
sage_docbuild.ext.inventory_builder.setup(app)15Documentation System, Release 10.4

2.2 Sage autodoc extension
This is sphinx.ext.autodoc extension modified for Sage objects.
The original header of sphinx.ext.autodoc:
Extension to create automatic documentation from code docstrings.
Automatically insert docstrings for functions, classes or whole modules into the doctree, thus avoiding duplication between docstrings and documentation for those who like elaborate docstrings.
This module is currently based on sphinx.ext.autodoc from Sphinx version 7.2.6. Compare (do diff) with the
upstream source file sphinx/ext/autodoc/__init__.py.
In the source file of this module, major modifications are delimited by a pair of comment dividers. To lessen maintenanceburden, we aim at reducing the modifications.
AUTHORS:• ? (before 2011): initial version derived from sphinx.ext.autodoc• Johan S. R. Nielsen: support for _sage_argspec_• Simon King (2011-04): use sageinspect; include public cython attributes only in the documentation if they have a
docstring• Kwankyu Lee (2018-12-26, 2022-11-08): rebased on the latest sphinx.ext.autodoc• Kwankyu Lee (2024-02-14): rebased on Sphinx 7.2.6
class sage_docbuild.ext.sage_autodoc.AttributeDocumenter(directive: DocumenterBridge,
name: str, indent: str = '')Bases: GenericAliasMixin, SlotsMixin, RuntimeInstanceAttributeMixin, UninitializedInstanceAttributeMixin, NonDataDescriptorMixin, DocstringStripSignatureMixin, ClassLevelDocumenter
Specialized Documenter subclass for attributes.
add_content(more_content)
add_directive_header(sig)classmethod can_document_member(member, membername, isattr, parent)
document_members(all_members=False)
get_attribute_comment(parent, attrname)get_doc()
get_real_modname()
import_object(raiseerror=False)
static is_function_or_method(obj)member_order = 60
order if autodoc_member_order is set to ‘groupwise’
objtype =attributename by which the directive is called (auto…) and the default generated directive name16

Chapter 2. Sphinx Extensions

Documentation System, Release 10.4

option_spec: OptionSpec = { annotation : <function annotation_option>,no-index : <function bool_option>, no-value : <function bool_option>,
noindex : <function bool_option>}priority = 10priority if multiple documenters return True from can_document_member
should_suppress_value_header()update_annotations(parent)
Update __annotations__ to support type_comment and so on.
class sage_docbuild.ext.sage_autodoc.ClassDocumenter(*args: Any)
Bases: DocstringSignatureMixin, ModuleLevelDocumenter
Specialized Documenter subclass for classes.
add_content(more_content)
add_directive_header(sig)classmethod can_document_member(member, membername, isattr, parent)
document_members(all_members=False)
format_args(**kwargs)
format_signature(**kwargs)
generate(more_content=None, real_modname=None, check_module=False, all_members=False)
get_canonical_fullname()
get_doc()
get_object_members(want_all)
get_overloaded_signatures()get_variable_comment()
import_object(raiseerror=False)
member_order = 20
order if autodoc_member_order is set to ‘groupwise’
objtype =class

name by which the directive is called (auto…) and the default generated directive nameoption_spec: OptionSpec = { class-doc-from : <function
class_doc_from_option>, exclude-members : <function
exclude_members_option>, inherited-members : <function
inherited_members_option>, member-order : <function
member_order_option>, members : <function members_option>, no-index :<function bool_option>, noindex : <function bool_option>,
private-members : <function members_option>, show-inheritance :<function bool_option>, special-members : <function members_option>,undoc-members : <function bool_option>}

2.2. Sage autodoc extension

17Documentation System, Release 10.4

priority = 15priority if multiple documenters return True from can_document_member
class sage_docbuild.ext.sage_autodoc.ClassLevelDocumenter(directive: DocumenterBridge,
name: str, indent: str = '')Bases: Documenter
Specialized Documenter subclass for objects on class level (methods, attributes).
resolve_name(modname, parents, path, base)class sage_docbuild.ext.sage_autodoc.DataDocumenter(directive: DocumenterBridge, name: str,
indent: str = '')Bases: GenericAliasMixin, UninitializedGlobalVariableMixin, ModuleLevelDocumenter
Specialized Documenter subclass for data items.
add_content(more_content)
add_directive_header(sig)classmethod can_document_member(member, membername, isattr, parent)
document_members(all_members=False)
get_doc()
get_module_comment(attrname)get_real_modname()
import_object(raiseerror=False)
member_order = 40
order if autodoc_member_order is set to ‘groupwise’
objtype =dataname by which the directive is called (auto…) and the default generated directive nameoption_spec: OptionSpec = { annotation : <function annotation_option>,no-index : <function bool_option>, no-value : <function bool_option>,
noindex : <function bool_option>}priority = -10
priority if multiple documenters return True from can_document_member
should_suppress_value_header()update_annotations(parent)
Update __annotations__ to support type_comment and so on.
class sage_docbuild.ext.sage_autodoc.DataDocumenterMixinBase
Bases: object
config: Config
env: BuildEnvironment

18

Chapter 2. Sphinx Extensions

Documentation System, Release 10.4

modname: str
object: Any
objpath: list[str]parent: Anyshould_suppress_directive_header()Check directive header should be suppressed.
should_suppress_value_header()Check :value: header should be suppressed.
update_content(more_content)
Update docstring, for example with TypeVar variance.
class sage_docbuild.ext.sage_autodoc.DecoratorDocumenter(directive: DocumenterBridge,
name: str, indent: str = '')Bases: FunctionDocumenter
Specialized Documenter subclass for decorator functions.
format_args(**kwargs)
objtype =decoratorname by which the directive is called (auto…) and the default generated directive namepriority = -1
priority if multiple documenters return True from can_document_member
class sage_docbuild.ext.sage_autodoc.DocstringSignatureMixin
Bases: object
Mixin for FunctionDocumenter and MethodDocumenter to provide the feature of reading the signature from the
docstring.
format_signature(**kwargs)
get_doc()class sage_docbuild.ext.sage_autodoc.DocstringStripSignatureMixin
Bases: DocstringSignatureMixin
Mixin for AttributeDocumenter to provide the feature of stripping any function signature from the docstring.
format_signature(**kwargs)
class sage_docbuild.ext.sage_autodoc.Documenter(directive: DocumenterBridge, name: str,
indent: str = '')Bases: object
A Documenter knows how to autodocument a single object type. When registered with the AutoDirective, it will
be used to document objects of that type when needed by autodoc.
Its objtype attribute selects what auto directive it is assigned to (the directive name is ‘auto’ + objtype), and what
directive it generates by default, though that can be overridden by an attribute called directivetype.
A Documenter has an option_spec that works like a docutils directive’s; in fact, it will be used to parse an auto
directive’s options that matches the Documenter.

2.2. Sage autodoc extension

19Documentation System, Release 10.4

add_content(more_content)
Add content from docstrings, attribute documentation and user.
add_directive_header(sig)
Add the directive header and options to the generated content.
add_line(line, source, *lineno)
Append one line of generated reST to the output.
classmethod can_document_member(member, membername, isattr, parent)
Called to see if a member can be documented by this Documenter.
check_module()
Check if self.object is really defined in the module given by self.modname.
content_indent =indentation by which to indent the directive content
document_members(all_members=False)
Generate reST for member documentation.
If all_members is True, document all members, else those given by self.options.members.
property documenters: dict[str, type[Documenter]]
Returns registered Documenter classes
filter_members(members, want_all)
Filter the given member list.
Members are skipped if• they are private (except if given explicitly or the private-members option is set)
• they are special methods (except if given explicitly or the special-members option is set)
• they are undocumented (except if the undoc-members option is set)
The user can override the skipping decision by connecting to the autodoc-skip-member event.
format_args(**kwargs)
Format the argument signature of self.object.
Should return None if the object does not have a signature.
format_name()
Format the name of self.object.
This normally should be something that can be parsed by the generated directive, but doesn’t need to be(Sphinx will display it unparsed then).
format_signature(**kwargs)
Format the signature (arguments and return annotation) of the object.
Let the user process it via the autodoc-process-signature event.
generate(more_content=None, real_modname=None, check_module=False, all_members=False)
Generate reST for the object given by self.name, and possibly for its members.
If more_content is given, include that content. If real_modname is given, use that module name to findattribute docs. If check_module is True, only generate if the object is defined in the module name it isimported from. If all_members is True, document all members.

20

Chapter 2. Sphinx Extensions

Documentation System, Release 10.4

get_attr(obj, name, *defargs)
getattr() override for types such as Zope interfaces.
get_doc()
Decode and return lines of the docstring(s) for the object.
When it returns None, autodoc-process-docstring will not be called for this object.
get_object_members(want_all)
Return (𝑚𝑒𝑚𝑏𝑒𝑟𝑠𝑐 ℎ𝑒𝑐𝑘𝑚 𝑜𝑑𝑢𝑙𝑒, 𝑚𝑒𝑚𝑏𝑒𝑟𝑠) where 𝑚𝑒𝑚𝑏𝑒𝑟𝑠 is a list of (𝑚𝑒𝑚𝑏𝑒𝑟𝑛𝑎𝑚𝑒, 𝑚𝑒𝑚𝑏𝑒𝑟) pairsof the members of self.object.
If want_all is True, return all members. Else, only return those members given by self.options.members (which
may also be None).
get_real_modname()
Get the real module name of an object to document.
It can differ from the name of the module through which the object was imported.
get_sourcename()
import_object(raiseerror=False)
Import the object given by self.modname and self.objpath and set it as self.object.
Returns True if successful, False if an error occurred.
member_order = 0
order if autodoc_member_order is set to ‘groupwise’
objtype =objectname by which the directive is called (auto…) and the default generated directive nameoption_spec: OptionSpec = { no-index : <function bool_option>,<function bool_option>}

noindex :parse_name()
Determine what module to import and what attribute to document.
Returns True and sets self.modname, self.objpath, self.fullname, self.args and self.retann if parsing and resolving was successful.
priority = 0
priority if multiple documenters return True from can_document_member
process_doc(docstrings)
Let the user process the docstrings before adding them.
resolve_name(modname, parents, path, base)
Resolve the module and name of the object to document given by the arguments and the current module/class.
Must return a pair of the module name and a chain of attributes; for example, it would return ( zipfile ,[ ZipFile , open ]) for the zipfile.ZipFile.open method.
sort_members(documenters, order)
Sort the given member list.
titles_allowed = True
true if the generated content may contain titles

2.2. Sage autodoc extension

21Documentation System, Release 10.4class sage_docbuild.ext.sage_autodoc.ExceptionDocumenter(*args: Any)
Bases: ClassDocumenter
Specialized ClassDocumenter subclass for exceptions.
classmethod can_document_member(member, membername, isattr, parent)
member_order = 10
order if autodoc_member_order is set to ‘groupwise’
objtype =exception

name by which the directive is called (auto…) and the default generated directive namepriority = 20priority if multiple documenters return True from can_document_member
class sage_docbuild.ext.sage_autodoc.FunctionDocumenter(directive: DocumenterBridge,
name: str, indent: str = '')Bases: DocstringSignatureMixin, ModuleLevelDocumenter
Specialized Documenter subclass for functions.
add_directive_header(sig)annotate_to_first_argument(func, typ)Annotate type hint to the first argument of function if needed.
classmethod can_document_member(member, membername, isattr, parent)
document_members(all_members=False)
format_args(**kwargs)
format_signature(**kwargs)
member_order = 30
order if autodoc_member_order is set to ‘groupwise’
merge_default_value(actual, overload)
Merge default values of actual implementation to the overload variants.
objtype =functionname by which the directive is called (auto…) and the default generated directive nameclass sage_docbuild.ext.sage_autodoc.GenericAliasMixin
Bases: DataDocumenterMixinBase
Mixin for DataDocumenter and AttributeDocumenter to provide the feature for supporting GenericAliases.
should_suppress_directive_header()update_content(more_content)
sage_docbuild.ext.sage_autodoc.INSTANCEATTR = <object object>
The base class of the class hierarchy.
When called, it accepts no arguments and returns a new featureless instance that has no instance attributes andcannot be given any.

22

Chapter 2. Sphinx Extensions

Documentation System, Release 10.4class sage_docbuild.ext.sage_autodoc.MethodDocumenter(directive: DocumenterBridge, name:str, indent: str = '')Bases: DocstringSignatureMixin, ClassLevelDocumenter
Specialized Documenter subclass for methods (normal, static and class).
add_directive_header(sig)annotate_to_first_argument(func, typ)Annotate type hint to the first argument of function if needed.
classmethod can_document_member(member, membername, isattr, parent)
directivetype =methoddocument_members(all_members=False)
format_args(**kwargs)
get_doc()
import_object(raiseerror=False)
member_order = 50
order if autodoc_member_order is set to ‘groupwise’
merge_default_value(actual, overload)
Merge default values of actual implementation to the overload variants.
objtype =methodname by which the directive is called (auto…) and the default generated directive namepriority = 1priority if multiple documenters return True from can_document_member
class sage_docbuild.ext.sage_autodoc.ModuleDocumenter(*args: Any)
Bases: Documenter
Specialized Documenter subclass for modules.
add_content(more_content)
add_directive_header(sig)classmethod can_document_member(member, membername, isattr, parent)
content_indent =indentation by which to indent the directive content
get_module_members()
Get members of target module.
get_object_members(want_all)import_object(raiseerror=False)
objtype = module
name by which the directive is called (auto…) and the default generated directive name2.2. Sage autodoc extension

23Documentation System, Release 10.4

option_spec: OptionSpec = { deprecated : <function bool_option>,
exclude-members : <function exclude_members_option>, ignore-module-all :<function bool_option>, imported-members : <function bool_option>,
inherited-members : <function inherited_members_option>, member-order :<function member_order_option>, members : <function members_option>,no-index : <function bool_option>, no-value : <function bool_option>,
noindex : <function bool_option>, platform : <function identity>,
private-members : <function members_option>, show-inheritance :<function bool_option>, special-members : <function members_option>,synopsis : <function identity>, undoc-members : <function bool_option>}parse_name()
resolve_name(modname, parents, path, base)sort_members(documenters, order)
class sage_docbuild.ext.sage_autodoc.ModuleLevelDocumenter(directive: DocumenterBridge,
name: str, indent: str = '')Bases: Documenter
Specialized Documenter subclass for objects on module level (functions, classes, data/constants).
resolve_name(modname, parents, path, base)class sage_docbuild.ext.sage_autodoc.NonDataDescriptorMixin
Bases: DataDocumenterMixinBase
Mixin for AttributeDocumenter to provide the feature for supporting non data-descriptors.
Note: This mix-in must be inherited after other mix-ins. Otherwise, docstring and :value: header will be suppressed unexpectedly.
get_doc()
import_object(raiseerror=False)
should_suppress_value_header()class sage_docbuild.ext.sage_autodoc.ObjectMember(name: str, obj: Any, *, docstring: str | None
= None, class_: Any | None = None,skipped: bool = False)
Bases: object
A member of object.
This is used for the result of 𝐷𝑜𝑐𝑢𝑚𝑒𝑛𝑡𝑒𝑟.𝑔𝑒𝑡𝑚 𝑜𝑑𝑢𝑙𝑒𝑚 𝑒𝑚𝑏𝑒𝑟𝑠() to represent each member of the object.
Note: An instance of this class behaves as a tuple of (name, object) for compatibility to old Sphinx. The behavior
will be dropped in the future. Therefore extensions should not use the tuple interface.
class sage_docbuild.ext.sage_autodoc.Options
Bases: dict
A dict/attribute hybrid that returns None on nonexisting keys.

24

Chapter 2. Sphinx Extensions

Documentation System, Release 10.4

copy()
class sage_docbuild.ext.sage_autodoc.PropertyDocumenter(directive: DocumenterBridge,
name: str, indent: str = '')Bases: DocstringStripSignatureMixin, ClassLevelDocumenter
Specialized Documenter subclass for properties.
add_directive_header(sig)classmethod can_document_member(member, membername, isattr, parent)
document_members(all_members=False)
format_args(**kwargs)
get_real_modname()
import_object(raiseerror=False)
Check the exisitence of uninitialized instance attribute when failed to import the attribute.
member_order = 60
order if autodoc_member_order is set to ‘groupwise’
objtype =property

name by which the directive is called (auto…) and the default generated directive namepriority = 11priority if multiple documenters return True from can_document_member
class sage_docbuild.ext.sage_autodoc.RuntimeInstanceAttributeMixin
Bases: DataDocumenterMixinBase
Mixin for AttributeDocumenter to provide the feature for supporting runtime instance attributes (that are defined
in __init__() methods with doc-comments).
Example:class Foo:def __init__(self):
self.attr = None #: This is a target of this mix-in.
RUNTIME_INSTANCE_ATTRIBUTE
get_doc()
import_object(raiseerror=False)
Check the existence of runtime instance attribute after failing to import the attribute.
is_runtime_instance_attribute(parent)
Check the subject is an attribute defined in __init__().
is_runtime_instance_attribute_not_commented(parent)
Check the subject is an attribute defined in __init__() without comment.
should_suppress_value_header()2.2. Sage autodoc extension

25Documentation System, Release 10.4class sage_docbuild.ext.sage_autodoc.SlotsMixin
Bases: DataDocumenterMixinBase
Mixin for AttributeDocumenter to provide the feature for supporting __slots__.
get_doc()
import_object(raiseerror=False)
isslotsattribute()
Check the subject is an attribute in __slots__.
should_suppress_value_header()class sage_docbuild.ext.sage_autodoc.UninitializedGlobalVariableMixin
Bases: DataDocumenterMixinBase
Mixin for DataDocumenter to provide the feature for supporting uninitialized (type annotation only) global variables.
get_doc()
import_object(raiseerror=False)
should_suppress_value_header()class sage_docbuild.ext.sage_autodoc.UninitializedInstanceAttributeMixin
Bases: DataDocumenterMixinBase
Mixin for AttributeDocumenter to provide the feature for supporting uninitialized instance attributes (PEP-526
styled, annotation only attributes).
Example:class Foo:
attr: int #: This is a target of this mix-in.
get_doc()
import_object(raiseerror=False)
Check the exisitence of uninitialized instance attribute when failed to import the attribute.
is_uninitialized_instance_attribute(parent)
Check the subject is an annotation only attribute.
should_suppress_value_header()sage_docbuild.ext.sage_autodoc.annotation_option(arg)sage_docbuild.ext.sage_autodoc.autodoc_attrgetter(app, obj, name, *defargs)
Alternative getattr() for types
sage_docbuild.ext.sage_autodoc.between(marker, what=None, keepempty=False, exclude=False)
Return a listener that either keeps, or if exclude is True excludes, lines between lines that match the marker regularexpression. If no line matches, the resulting docstring would be empty, so no change will be made unless keepempty
is true.
If what is a sequence of strings, only docstrings of a type in what will be processed.
sage_docbuild.ext.sage_autodoc.bool_option(arg)Used to convert flag options to auto directives. (Instead of directives.flag(), which returns None).

26

Chapter 2. Sphinx Extensions

Documentation System, Release 10.4

sage_docbuild.ext.sage_autodoc.class_doc_from_option(arg)Used to convert the :class-doc-from: option to autoclass directives.
sage_docbuild.ext.sage_autodoc.cut_lines(pre, post=0, what=None)
Return a listener that removes the first pre and last post lines of every docstring. If what is a sequence of strings,
only docstrings of a type in what will be processed.
Use like this (e.g. in the setup() function of conf.py):
from sphinx.ext.autodoc import cut_lines
app.connect( autodoc-process-docstring , cut_lines(4, what=[ module ]))This can (and should) be used in place of automodule_skip_lines.
sage_docbuild.ext.sage_autodoc.exclude_members_option(arg)Used to convert the :exclude-members: option.
sage_docbuild.ext.sage_autodoc.getdoc(obj, *args, **kwargs)
sage_docbuild.ext.sage_autodoc.identity(x)sage_docbuild.ext.sage_autodoc.inherited_members_option(arg)Used to convert the :inherited-members: option to auto directives.
sage_docbuild.ext.sage_autodoc.member_order_option(arg)Used to convert the :member-order: option to auto directives.
sage_docbuild.ext.sage_autodoc.members_option(arg)Used to convert the :members: option to auto directives.
sage_docbuild.ext.sage_autodoc.merge_members_option(options)
Merge :private-members: and :special-members: options to the :members: option.
sage_docbuild.ext.sage_autodoc.py_ext_sig_re = re.compile( ^ ([\\w.]+::)? #explicit module name\n ([\\w.]+\\.)? # module and/or class name(s)\n (\\w+)\\s* # thing name\n (?: \\[\\s*(.*)\\s*])? , re.VERBOSE)
extended signature RE: with explicit module name separated by “::”
sage_docbuild.ext.sage_autodoc.setup(app)

2.3 Sage multidocs extension
The goal of this extension is to manage a multi-documentation in Sphinx. To be able to compile Sage’s huge documentationin parallel, the documentation is cut into a bunch of independent documentations called “sub-docs”, which are compiled
separately. There is a master document which points to all the sub-docs. The intersphinx extension ensures that thecross-link between the sub-docs are correctly resolved. However some work is needed to build a global index. This is thegoal of the multidocs extension.
More precisely this extension ensures the correct merging of• the todo list if this extension is activated• the python indexes• the list of python modules• the javascript index

2.3. Sage multidocs extension

27Documentation System, Release 10.4

• the citations
sage_docbuild.ext.multidocs.citation_dir(app)sage_docbuild.ext.multidocs.fetch_citation(app, env)
Fetch the global citation index from the refman to allow for cross references.
sage_docbuild.ext.multidocs.fix_path_html(app, pagename, templatename, ctx, event_arg)
Fix the context so that the files• search.html• genindex.html• py-modindex.html
point to the right place, that is in reference/ instead of reference/subdocument.
sage_docbuild.ext.multidocs.get_env(app, curdoc)
Get the environment of a sub-doc from the pickle
sage_docbuild.ext.multidocs.get_js_index(app, curdoc)
Get the JS index of a sub-doc from the file
sage_docbuild.ext.multidocs.init_subdoc(app)
Init the merger depending on if we are compiling a sub-doc or the master doc itself.
sage_docbuild.ext.multidocs.merge_environment(app, env)
Merge the following attributes of the sub-docs environment into the main environment:• titles – Titles• todo_all_todos – todo’s• indexentries – global python index• all_docs – needed by the js index• citations – citations• domaindata[ py ][ modules ] – list of python modules
sage_docbuild.ext.multidocs.merge_js_index(app)Merge the JS indexes of the sub-docs into the main JS index
sage_docbuild.ext.multidocs.setup(app)sage_docbuild.ext.multidocs.write_citations(app, citations)
Pickle the citation in a file.

28

Chapter 2. Sphinx Extensions

PYTHON MODULE INDEXssage_docbuild.__main__, 1
sage_docbuild.build_options, 8
sage_docbuild.builders, 4
sage_docbuild.conf, 10
sage_docbuild.ext.inventory_builder, 15
sage_docbuild.ext.multidocs, 27
sage_docbuild.ext.sage_autodoc, 16
sage_docbuild.sphinxbuild, 8
sage_docbuild.utils, 1129Documentation System, Release 10.4

30

Python Module Index

INDEXA
add_content() (sage_docbuild.ext.sage_autodoc.AttributeDocumenter method), 16
add_content() (sage_docbuild.ext.sage_autodoc.ClassDocumenter method), 17
add_content() (sage_docbuild.ext.sage_autodoc.DataDocumenter method), 18
add_content() (sage_docbuild.ext.sage_autodoc.Documenter method), 19
add_content() (sage_docbuild.ext.sage_autodoc.ModuleDocumenter method), 23
add_directive_header()(sage_docbuild.ext.sage_autodoc.AttributeDocumenter method), 16
add_directive_header()(sage_docbuild.ext.sage_autodoc.ClassDocumenter method), 17
add_directive_header()(sage_docbuild.ext.sage_autodoc.DataDocumenter method), 18
add_directive_header()(sage_docbuild.ext.sage_autodoc.Documenter
method), 20
add_directive_header()(sage_docbuild.ext.sage_autodoc.FunctionDocumenter method), 22
add_directive_header()(sage_docbuild.ext.sage_autodoc.MethodDocumenter method), 23
add_directive_header()(sage_docbuild.ext.sage_autodoc.ModuleDocumenter method), 23
add_directive_header()(sage_docbuild.ext.sage_autodoc.PropertyDocumenter method), 25
add_line()(sage_docbuild.ext.sage_autodoc.Documenter method), 20
add_page_context()(inmodulesage_docbuild.conf), 10
AllBuilder (class in sage_docbuild.builders), 4
annotate_to_first_argument()(sage_docbuild.ext.sage_autodoc.Function-

Documenter method), 22
annotate_to_first_argument()(sage_docbuild.ext.sage_autodoc.MethodDocumenter method), 23
annotation_option()(inmodulesage_docbuild.ext.sage_autodoc), 26
ansi_escape_sequence(sage_docbuild.sphinxbuild.SageSphinxLogger attribute), 8
ansi_escape_sequence_color(sage_docbuild.sphinxbuild.SageSphinxLogger attribute), 9
apply()(sage_docbuild.conf.SagecodeTransform
method), 10
AttributeDocumenter(classin
sage_docbuild.ext.sage_autodoc), 16
auto_rest_filename()(sage_docbuild.builders.ReferenceSubBuilder
method), 6
autodoc_attrgetter()(inmodulesage_docbuild.ext.sage_autodoc), 26

B
between() (in module sage_docbuild.ext.sage_autodoc),26
bool_option()(inmodulesage_docbuild.ext.sage_autodoc), 26
build_many() (in module sage_docbuild.builders), 8
build_many() (in module sage_docbuild.utils), 11
build_other_doc()(inmodulesage_docbuild.builders), 8
build_ref_doc() (in module sage_docbuild.builders),8
builder_helper()(inmodulesage_docbuild.builders), 8Ccache_filename()(sage_docbuild.builders.ReferenceSubBuilder method), 6
call_intersphinx()(inmodulesage_docbuild.conf), 10

31

Documentation System, Release 10.4

can_document_member()content_indent (sage_docbuild.ext.sage_autodoc.Mod(sage_docbuild.ext.sage_autodoc.AttributeuleDocumenter attribute), 23
Documenter class method), 16
copy()(sage_docbuild.ext.sage_autodoc.Options
can_document_member()method), 24(sage_docbuild.ext.sage_autodoc.ClassDocucut_lines()(inmodulementer class method), 17
sage_docbuild.ext.sage_autodoc), 27
can_document_member()D(sage_docbuild.ext.sage_autodoc.DataDocumenter class method), 18
DataDocumenter(classin
can_document_member()
sage_docbuild.ext.sage_autodoc), 18(sage_docbuild.ext.sage_autodoc.Documenter
DataDocumenterMixinBase(classinclass method), 20
sage_docbuild.ext.sage_autodoc), 18
can_document_member()debug_inf() (in module sage_docbuild.conf), 10(sage_docbuild.ext.sage_autodoc.ExceptionDecoratorDocumenter(classinDocumenter class method), 22
sage_docbuild.ext.sage_autodoc), 19
can_document_member()default_priority(sage_docbuild.conf.Sagecode(sage_docbuild.ext.sage_autodoc.FunctionTransform attribute), 10
Documenter class method), 22
directivetype (sage_docbuild.ext.sage_autodoc.Methodcan_document_member()Documenter attribute), 23(sage_docbuild.ext.sage_autodoc.MethodDocBuilder (class in sage_docbuild.builders), 4
Documenter class method), 23
DocstringSignatureMixin(classin
can_document_member()
sage_docbuild.ext.sage_autodoc), 19(sage_docbuild.ext.sage_autodoc.ModuleDocstringStripSignatureMixin(classinDocumenter class method), 23
sage_docbuild.ext.sage_autodoc), 19
can_document_member()
document_members()(sage_docbuild.ext.sage_autodoc.Property(sage_docbuild.ext.sage_autodoc.AttributeDocumenter class method), 25
Documenter method), 16
changes()(sage_docbuild.builders.DocBuilder document_members()
method), 5(sage_docbuild.ext.sage_autodoc.ClassDocucheck_module() (sage_docbuild.ext.sage_autodoc.Docmenter method), 17
umenter method), 20
document_members()
check_nested_class_picklability()(in(sage_docbuild.ext.sage_autodoc.DataDocumodule sage_docbuild.conf), 10
menter method), 18
citation_dir() (in module sage_docbuild.ext.multi- document_members()docs), 28(sage_docbuild.ext.sage_autodoc.Documenterclass_doc_from_option()(inmodulemethod), 20
sage_docbuild.ext.sage_autodoc), 26
document_members()
ClassDocumenter(classin(sage_docbuild.ext.sage_autodoc.Functionsage_docbuild.ext.sage_autodoc), 17
Documenter method), 22
ClassLevelDocumenter(classin document_members()
sage_docbuild.ext.sage_autodoc), 18(sage_docbuild.ext.sage_autodoc.Methodclean() (sage_docbuild.builders.DocBuilder method), 5
Documenter method), 23
clean()(sage_docbuild.builders.WebsiteBuilder document_members()
method), 8(sage_docbuild.ext.sage_autodoc.Propertyclean_auto() (sage_docbuild.builders.ReferenceSubDocumenter method), 25
Builder method), 6
Documenter (class in sage_docbuild.ext.sage_autodoc),close() (sage_docbuild.sphinxbuild.SageSphinxLogger
19
method), 9
documenters (sage_docbuild.ext.sage_autodoc.Docuclosed (sage_docbuild.sphinxbuild.SageSphinxLogger atmenter property), 20
tribute), 9
config(sage_docbuild.ext.sage_autodoc.DataDocu- E
menterMixinBase attribute), 18
encoding (sage_docbuild.sphinxbuild.SageSphinxLogger
content_indent (sage_docbuild.ext.sage_autodoc.Docattribute), 9
umenter attribute), 20
32

Index

Documentation System, Release 10.4

(sage_docbuild.ext.sage_autodoc.DataDocumenter(sage_docbuild.ext.sage_autodoc.Documenter
MixinBase attribute), 18
method), 20
epilog (sage_docbuild.ext.inventory_builder.Inventory- format_signature()
Builder attribute), 15(sage_docbuild.ext.sage_autodoc.Functionexc (sage_docbuild.utils.RemoteExceptionWrapper atDocumenter method), 22
tribute), 11
FunctionDocumenter(classin
ExceptionDocumenter(classin
sage_docbuild.ext.sage_autodoc), 22
sage_docbuild.ext.sage_autodoc), 21
exclude_members_option()(inmodule G
sage_docbuild.ext.sage_autodoc), 27
generate()(sage_docbuild.ext.sage_autodoc.ClassDocumenter method), 17
F
generate()(sage_docbuild.ext.sage_autodoc.Docufetch_citation() (in module sage_docbuild.ext.mulmenter method), 20
tidocs), 28
GenericAliasMixin(classinfetch_inventory() (sage_docbuild.__main__.Intersage_docbuild.ext.sage_autodoc), 22
sphinxCache method), 2
get_all_documents() (sage_docbuild.builders.Allfilter_members() (sage_docbuild.ext.sage_autodoc.DocBuilder method), 4
umenter method), 20
get_all_documents() (sage_docbuild.builders.Reffind_sage_dangling_links()(inmoduleerenceBuilder method), 5
sage_docbuild.conf), 11
get_all_included_modules()finish() (sage_docbuild.ext.inventory_builder.Invento(sage_docbuild.builders.ReferenceSubBuilder
ryBuilder method), 15
method), 6
fix_path_html() (in module sage_docbuild.ext.multi- get_all_rst_files() (sage_docbuild.builders.Refdocs), 28
erenceSubBuilder method), 6
flush() (sage_docbuild.sphinxbuild.SageSphinxLogger get_attr()(sage_docbuild.ext.sage_autodoc.Documethod), 9
menter method), 20
format (sage_docbuild.ext.inventory_builder.Inventory- get_attribute_comment()
Builder attribute), 15(sage_docbuild.ext.sage_autodoc.Attributeformat_args() (sage_docbuild.ext.sage_autodoc.ClassDocumenter method), 16
Documenter method), 17
get_builder() (in module sage_docbuild.builders), 8
format_args() (sage_docbuild.ext.sage_autodoc.Dec- get_cache() (sage_docbuild.builders.ReferenceSuboratorDocumenter method), 19
Builder method), 6
format_args() (sage_docbuild.ext.sage_autodoc.Doc- get_canonical_fullname()umenter method), 20(sage_docbuild.ext.sage_autodoc.ClassDocuformat_args() (sage_docbuild.ext.sage_autodoc.Funcmenter method), 17
tionDocumenter method), 22
get_doc() (sage_docbuild.ext.sage_autodoc.Attributeformat_args() (sage_docbuild.ext.sage_autodoc.MethodDocumenter method), 16
Documenter method), 23
get_doc() (sage_docbuild.ext.sage_autodoc.ClassDocuformat_args() (sage_docbuild.ext.sage_autodoc.Propmenter method), 17
ertyDocumenter method), 25
get_doc() (sage_docbuild.ext.sage_autodoc.DataDocuformat_columns()(inmodulementer method), 18
sage_docbuild.__main__), 2
get_doc()(sage_docbuild.ext.sage_autodoc.Docformat_name() (sage_docbuild.ext.sage_autodoc.DocstringSignatureMixin method), 19
umenter method), 20
get_doc()(sage_docbuild.ext.sage_autodoc.Docuformat_signature()menter method), 21(sage_docbuild.ext.sage_autodoc.ClassDocuget_doc() (sage_docbuild.ext.sage_autodoc.Methodmenter method), 17
Documenter method), 23
format_signature()
get_doc()(sage_docbuild.ext.sage_autodoc.Non(sage_docbuild.ext.sage_autodoc.DocstringSigDataDescriptorMixin method), 24
natureMixin method), 19
get_doc() (sage_docbuild.ext.sage_autodoc.RuntimeInformat_signature()
stanceAttributeMixin method), 25(sage_docbuild.ext.sage_autodoc.Docget_doc() (sage_docbuild.ext.sage_autodoc.SlotsMixin
stringStripSignatureMixin method), 19
method), 26
format_signature()
env

Index

33

Documentation System, Release 10.4

get_doc() (sage_docbuild.ext.sage_autodoc.UninitializedGlobalVariableMixin method), 26
get_doc() (sage_docbuild.ext.sage_autodoc.UninitializedInstanceAttributeMixin method), 26
get_documents() (in module sage_docbuild.builders),8
get_env() (in module sage_docbuild.ext.multidocs), 28
get_formats() (in module sage_docbuild.__main__),2get_js_index() (in module sage_docbuild.ext.multidocs), 28
get_modified_modules()(sage_docbuild.builders.ReferenceSubBuilder
method), 7
get_module_comment()(sage_docbuild.ext.sage_autodoc.DataDocumenter method), 18
get_module_docstring_title()(sage_docbuild.builders.ReferenceSubBuilder
method), 7
get_module_members()(sage_docbuild.ext.sage_autodoc.ModuleDocumenter method), 23
get_modules() (sage_docbuild.builders.ReferenceSubBuilder method), 7
get_new_and_updated_modules()(sage_docbuild.builders.ReferenceSubBuilder
method), 7
get_object_members()(sage_docbuild.ext.sage_autodoc.ClassDocumenter method), 17
get_object_members()(sage_docbuild.ext.sage_autodoc.Documenter
method), 21
get_object_members()(sage_docbuild.ext.sage_autodoc.ModuleDocumenter method), 23
get_outdated_docs()(sage_docbuild.ext.inventory_builder.InventoryBuilder method), 15
get_overloaded_signatures()(sage_docbuild.ext.sage_autodoc.ClassDocumenter method), 17
get_real_modname()(sage_docbuild.ext.sage_autodoc.AttributeDocumenter method), 16
get_real_modname()(sage_docbuild.ext.sage_autodoc.DataDocumenter method), 18
get_real_modname()(sage_docbuild.ext.sage_autodoc.Documenter
method), 21
get_real_modname()(sage_docbuild.ext.sage_autodoc.PropertyDocumenter method), 25
34

get_sourcename() (sage_docbuild.ext.sage_autodoc.Documenter method), 21
get_sphinx_environment()(sage_docbuild.builders.ReferenceSubBuilder
method), 7
get_target_uri()(sage_docbuild.ext.inventory_builder.InventoryBuilder method), 15
get_unincluded_modules()(sage_docbuild.builders.ReferenceSubBuilder
method), 7
get_variable_comment()(sage_docbuild.ext.sage_autodoc.ClassDocumenter method), 17
getdoc() (in module sage_docbuild.ext.sage_autodoc),
27

H
has() (sage_docbuild.conf.Tags method), 10
help_commands()(inmodulesage_docbuild.__main__), 2
help_description()(inmodulesage_docbuild.__main__), 2
help_documents()(inmodulesage_docbuild.__main__), 2
help_examples()(in
modulesage_docbuild.__main__), 3
help_formats()(inmodulesage_docbuild.__main__), 3
help_message_long(classin
sage_docbuild.__main__), 3
help_message_short(classin
sage_docbuild.__main__), 3
help_usage() (in module sage_docbuild.__main__), 3
help_wrapper (class in sage_docbuild.__main__), 3
html() (sage_docbuild.builders.DocBuilder method), 5
html()(sage_docbuild.builders.ReferenceTopBuilder
method), 7
html() (sage_docbuild.builders.WebsiteBuilder method),8
htmlhelp()(sage_docbuild.builders.DocBuilder
method), 5I
identity()(inmodulesage_docbuild.ext.sage_autodoc), 27
import_object() (sage_docbuild.ext.sage_autodoc.AttributeDocumenter method), 16
import_object() (sage_docbuild.ext.sage_autodoc.ClassDocumenter method), 17
import_object() (sage_docbuild.ext.sage_autodoc.DataDocumenter method), 18
import_object() (sage_docbuild.ext.sage_autodoc.Documenter method), 21

Index

Documentation System, Release 10.4

import_object() (sage_docbuild.ext.sage_autodoc.Methodlinkcode_resolve()(inmoduleDocumenter method), 23
sage_docbuild.conf), 11
import_object() (sage_docbuild.ext.sage_autodoc.ModM
uleDocumenter method), 23
import_object() (sage_docbuild.ext.sage_autodoc.Non-main() (in module sage_docbuild.__main__), 3
DataDescriptorMixin method), 24
member_order(sage_docbuild.ext.sage_autodoc.Atimport_object() (sage_docbuild.ext.sage_autodoc.ProptributeDocumenter attribute), 16
ertyDocumenter method), 25
member_order (sage_docbuild.ext.sage_autodoc.Classimport_object() (sage_docbuild.ext.sage_autodoc.RunDocumenter attribute), 17
timeInstanceAttributeMixin method), 25
member_order (sage_docbuild.ext.sage_autodoc.Dataimport_object() (sage_docbuild.ext.sage_autodoc.SlotsMixin
Documenter attribute), 18
method), 26
member_order (sage_docbuild.ext.sage_autodoc.Docuimport_object() (sage_docbuild.ext.sage_autodoc.Uninimenter attribute), 21
tializedGlobalVariableMixin method), 26
member_order (sage_docbuild.ext.sage_autodoc.Excepimport_object() (sage_docbuild.ext.sage_autodoc.UninitionDocumenter attribute), 22
tializedInstanceAttributeMixin method), 26
member_order (sage_docbuild.ext.sage_autodoc.Funcinherited_members_option()(inmoduletionDocumenter attribute), 22
sage_docbuild.ext.sage_autodoc), 27
member_order (sage_docbuild.ext.sage_autodoc.Methodinit_subdoc() (in module sage_docbuild.ext.multiDocumenter attribute), 23
docs), 28member_order (sage_docbuild.ext.sage_autodoc.PropINSTANCEATTR(in
moduleertyDocumenter attribute), 25
sage_docbuild.ext.sage_autodoc), 22
member_order_option()(inmoduleIntersphinxCache(classin
sage_docbuild.ext.sage_autodoc), 27
sage_docbuild.__main__), 2
members_option()(inmoduleinventory()(sage_docbuild.builders.DocBuilder
sage_docbuild.ext.sage_autodoc), 27
method), 5
merge_default_value()
InventoryBuilder (class in sage_docbuild.ext.inven(sage_docbuild.ext.sage_autodoc.Functiontory_builder), 15
Documenter method), 22
is_function_or_method()merge_default_value()(sage_docbuild.ext.sage_autodoc.Attribute(sage_docbuild.ext.sage_autodoc.MethodDocumenter static method), 16
Documenter method), 23
is_runtime_instance_attribute()
merge_environment()(inmodule(sage_docbuild.ext.sage_autodoc.RuntimeInsage_docbuild.ext.multidocs), 28
stanceAttributeMixin method), 25
merge_js_index() (in module sage_docbuild.ext.mulis_runtime_instance_attidocs), 28
tribute_not_commented()merge_members_option()(inmodule(sage_docbuild.ext.sage_autodoc.RuntimeInsage_docbuild.ext.sage_autodoc), 27
stanceAttributeMixin method), 25
MethodDocumenter(classin
is_uninitialized_instance_attribute()
sage_docbuild.ext.sage_autodoc), 22(sage_docbuild.ext.sage_autodoc.UninitializedIn- mode(sage_docbuild.sphinxbuild.SageSphinxLogger
stanceAttributeMixin method), 26
attribute), 9
isatty() (sage_docbuild.sphinxbuild.SageSphinxLogger modname(sage_docbuild.ext.sage_autodoc.DataDocumethod), 9
menterMixinBase attribute), 18
isslotsattribute()
module(sage_docbuild.ext.sage_autodoc.SlotsMixin
sage_docbuild.__main__, 1
method), 26
sage_docbuild.build_options, 8
sage_docbuild.builders, 4
J
sage_docbuild.conf, 10json() (sage_docbuild.builders.DocBuilder method), 5
sage_docbuild.ext.inventory_builder, 15
Lsage_docbuild.ext.multidocs, 27
sage_docbuild.ext.sage_autodoc, 16
latex() (sage_docbuild.builders.DocBuilder method), 5
sage_docbuild.sphinxbuild, 8
linkcheck()(sage_docbuild.builders.DocBuilder
sage_docbuild.utils, 11
method), 5
Index

35

Documentation System, Release 10.4

ModuleDocumenter(classsage_docbuild.ext.sage_autodoc), 23
ModuleLevelDocumenter(classsage_docbuild.ext.sage_autodoc), 24

in
in

N
(sage_docbuild.ext.inventory_builder.InventoryBuilder attribute), 15
name(sage_docbuild.sphinxbuild.SageSphinxLogger
attribute), 9
newlines (sage_docbuild.sphinxbuild.SageSphinxLogger
attribute), 9
NonDataDescriptorMixin(classin
sage_docbuild.ext.sage_autodoc), 24
nameO

original_exception(sage_docbuild.utils.WorkerDiedException attribute), 11

P(sage_docbuild.ext.sage_autodoc.DataDocumenterMixinBase attribute), 19
parse_name() (sage_docbuild.ext.sage_autodoc.Documenter method), 21
parse_name() (sage_docbuild.ext.sage_autodoc.ModuleDocumenter method), 24
pdf() (sage_docbuild.builders.DocBuilder method), 5
pdf() (sage_docbuild.builders.WebsiteBuilder method), 8
pickle() (sage_docbuild.builders.DocBuilder method),5
prefix_len(sage_docbuild.sphinxbuild.SageSphinxLogger attribute), 9
print_included_modules()(sage_docbuild.builders.ReferenceSubBuilder
method), 7
print_modified_modules()(sage_docbuild.builders.ReferenceSubBuilder
method), 7
print_new_and_updated_modules()(sage_docbuild.builders.ReferenceSubBuilder
method), 7
print_unincluded_modules()(sage_docbuild.builders.ReferenceSubBuilder
method), 7
priority(sage_docbuild.ext.sage_autodoc.AttributeDocumenter attribute), 17
priority (sage_docbuild.ext.sage_autodoc.ClassDocumenter attribute), 17
priority (sage_docbuild.ext.sage_autodoc.DataDocumenter attribute), 18
priority (sage_docbuild.ext.sage_autodoc.DecoratorDocumenter attribute), 19
priority (sage_docbuild.ext.sage_autodoc.Documenter
attribute), 21
priority (sage_docbuild.ext.sage_autodoc.ExceptionDocumenter attribute), 22
priority (sage_docbuild.ext.sage_autodoc.MethodDocumenter attribute), 23
priority(sage_docbuild.ext.sage_autodoc.PropertyDocumenter attribute), 25
process_doc() (sage_docbuild.ext.sage_autodoc.Documenter method), 21
PropertyDocumenter(classin
sage_docbuild.ext.sage_autodoc), 25
py_ext_sig_re(inmodulesage_docbuild.ext.sage_autodoc), 27
parent(sage_docbuild.ext.sage_autodoc.DataDocumenterMixinBase attribute), 19
ObjectMember(classin
sage_docbuild.ext.sage_autodoc), 24
objpath(sage_docbuild.ext.sage_autodoc.DataDocumenterMixinBase attribute), 19
objtype (sage_docbuild.ext.sage_autodoc.AttributeDocumenter attribute), 16
objtype (sage_docbuild.ext.sage_autodoc.ClassDocumenter attribute), 17
objtype(sage_docbuild.ext.sage_autodoc.DataDocumenter attribute), 18
objtype(sage_docbuild.ext.sage_autodoc.DecoratorDocumenter attribute), 19
objtype (sage_docbuild.ext.sage_autodoc.Documenter
attribute), 21
objtype (sage_docbuild.ext.sage_autodoc.ExceptionDocumenter attribute), 22
objtype (sage_docbuild.ext.sage_autodoc.FunctionDocumenter attribute), 22
objtype (sage_docbuild.ext.sage_autodoc.MethodDocumenter attribute), 23
objtype (sage_docbuild.ext.sage_autodoc.ModuleDocumenter attribute), 23
objtype (sage_docbuild.ext.sage_autodoc.PropertyDocumenter attribute), 25
option_spec(sage_docbuild.ext.sage_autodoc.AttributeDocumenter attribute), 16
option_spec (sage_docbuild.ext.sage_autodoc.ClassDocumenter attribute), 17
option_spec (sage_docbuild.ext.sage_autodoc.DataDocumenter attribute), 18
option_spec (sage_docbuild.ext.sage_autodoc.Documenter attribute), 21
option_spec (sage_docbuild.ext.sage_autodoc.ModuleR
Documenter attribute), 23
raise_errors()(sage_docbuild.sphinxbuild.SageOptions (class in sage_docbuild.ext.sage_autodoc), 24
SphinxLogger method), 9
object36

Index

Documentation System, Release 10.4

ReferenceBuilder (class in sage_docbuild.builders), setup() (in module sage_docbuild.ext.sage_autodoc), 27
5
setup_logger()(inmoduleReferenceSubBuilder(classin
sage_docbuild.__main__), 3
sage_docbuild.builders), 6
setup_parser()(inmoduleReferenceTopBuilder(classin
sage_docbuild.__main__), 3
sage_docbuild.builders), 7
should_suppress_directive_header()RemoteException, 11(sage_docbuild.ext.sage_autodoc.DataDocuRemoteExceptionWrapper(classinmenterMixinBase method), 19
sage_docbuild.utils), 11
should_suppress_directive_header()resolve_name() (sage_docbuild.ext.sage_autodoc.ClassLevel(sage_docbuild.ext.sage_autodoc.GenericAliasDocumenter method), 18
Mixin method), 22
resolve_name() (sage_docbuild.ext.sage_autodoc.Doc- should_suppress_value_header()umenter method), 21(sage_docbuild.ext.sage_autodoc.Attributeresolve_name() (sage_docbuild.ext.sage_autodoc.ModDocumenter method), 17
uleDocumenter method), 24
should_suppress_value_header()resolve_name() (sage_docbuild.ext.sage_autodoc.Mod(sage_docbuild.ext.sage_autodoc.DataDocuuleLevelDocumenter method), 24
menter method), 18
runsphinx() (in module sage_docbuild.sphinxbuild), 9 should_suppress_value_header()RUNTIME_INSTANCE_ATTRIBUTE(sage_docbuild.ext.sage_autodoc.DataDocu(sage_docbuild.ext.sage_autodoc.RuntimeInmenterMixinBase method), 19
stanceAttributeMixin attribute), 25
should_suppress_value_header()RuntimeInstanceAttributeMixin (class in(sage_docbuild.ext.sage_autodoc.NonDataDesage_docbuild.ext.sage_autodoc), 25
scriptorMixin method), 24
should_suppress_value_header()S(sage_docbuild.ext.sage_autodoc.RuntimeInstanceAttributeMixin method), 25
sage_docbuild.__main__should_suppress_value_header()module, 1(sage_docbuild.ext.sage_autodoc.SlotsMixin
sage_docbuild.build_options
method), 26
module, 8
should_suppress_value_header()sage_docbuild.builders(sage_docbuild.ext.sage_autodoc.Uninitialmodule, 4izedGlobalVariableMixin method), 26
sage_docbuild.conf
should_suppress_value_header()module, 10(sage_docbuild.ext.sage_autodoc.Uninitialsage_docbuild.ext.inventory_builder
izedInstanceAttributeMixin method), 26
module, 15SingleFileBuilder(classin
sage_docbuild.ext.multidocs
sage_docbuild.builders), 7
module, 27
skip_member() (in module sage_docbuild.conf), 11
sage_docbuild.ext.sage_autodoc
SlotsMixin (class in sage_docbuild.ext.sage_autodoc),
module, 16
25
sage_docbuild.sphinxbuild
softspace (sage_docbuild.sphinxbuild.SageSphinxLogmodule, 8
ger attribute), 9
sage_docbuild.utils
sort_members() (sage_docbuild.ext.sage_autodoc.Docmodule, 11umenter method), 21
SagecodeTransform (class in sage_docbuild.conf), 10
SageSphinxLogger(classin sort_members() (sage_docbuild.ext.sage_autodoc.ModuleDocumenter method), 24
sage_docbuild.sphinxbuild), 8
save_cache() (sage_docbuild.builders.ReferenceSubT
Builder method), 7
set_intersphinx_mappings()(inmodule Tags (class in sage_docbuild.conf), 10tb (sage_docbuild.utils.RemoteException attribute), 11
sage_docbuild.conf), 11
tb (sage_docbuild.utils.RemoteExceptionWrapper atsetup() (in module sage_docbuild.conf), 11
tribute), 11
setup()(inmodulesage_docbuild.ext.inventerm_width_line()(inmoduletory_builder), 15
sage_docbuild.sphinxbuild), 10
setup() (in module sage_docbuild.ext.multidocs), 28
Index

37

Documentation System, Release 10.4

titles_allowed (sage_docbuild.ext.sage_autodoc.Documenter attribute), 21

U
UninitializedGlobalVariableMixin (class in
sage_docbuild.ext.sage_autodoc), 26
UninitializedInstanceAttributeMixin(class in sage_docbuild.ext.sage_autodoc), 26
update_annotations()(sage_docbuild.ext.sage_autodoc.AttributeDocumenter method), 17
update_annotations()(sage_docbuild.ext.sage_autodoc.DataDocumenter method), 18
update_content() (sage_docbuild.ext.sage_autodoc.DataDocumenterMixinBase method), 19
update_content() (sage_docbuild.ext.sage_autodoc.GenericAliasMixin method), 22
update_mtimes() (sage_docbuild.builders.ReferenceSubBuilder method), 7

W
web() (sage_docbuild.builders.DocBuilder method), 5
WebsiteBuilder (class in sage_docbuild.builders), 7
WorkerDiedException, 11
write() (sage_docbuild.sphinxbuild.SageSphinxLogger
method), 9
write_auto_rest_file()(sage_docbuild.builders.ReferenceSubBuilder
method), 7
write_citations()(inmodulesage_docbuild.ext.multidocs), 28
writelines()(sage_docbuild.sphinxbuild.SageSphinxLogger method), 938

Index