Sphinx configuration shared by sage.misc.sphinxify and sage_docbuild#
- class sage.misc.sagedoc_conf.SagemathTransform(document, startnode=None)#
Bases:
Transform
Transform for code-blocks.
This allows Sphinx to treat code-blocks with prompt “sage:” as associated with the pycon lexer, and in particular, to change “<BLANKLINE>” to a blank line.
- apply()#
- default_priority = 500#
Numerical priority of this transform, 0 through 999 (override).
- sage.misc.sagedoc_conf.process_directives(app, what, name, obj, options, docstringlines)#
Remove ‘nodetex’ and other directives from the first line of any docstring where they appear.
- sage.misc.sagedoc_conf.process_docstring_aliases(app, what, name, obj, options, docstringlines)#
Change the docstrings for aliases to point to the original object.
- sage.misc.sagedoc_conf.process_docstring_cython(app, what, name, obj, options, docstringlines)#
Remove Cython’s filename and location embedding.
- sage.misc.sagedoc_conf.process_docstring_module_title(app, what, name, obj, options, docstringlines)#
Removes the first line from the beginning of the module’s docstring. This corresponds to the title of the module’s documentation page.
- sage.misc.sagedoc_conf.process_dollars(app, what, name, obj, options, docstringlines)#
Replace dollar signs with backticks.
See sage.misc.sagedoc.process_dollars for more information.
- sage.misc.sagedoc_conf.process_inherited(app, what, name, obj, options, docstringlines)#
If we’re including inherited members, omit their docstrings.
- sage.misc.sagedoc_conf.setup(app)#
- sage.misc.sagedoc_conf.skip_TESTS_block(app, what, name, obj, options, docstringlines)#
Skip blocks labeled “TESTS:”.
See sage.misc.sagedoc.skip_TESTS_block for more information.