List of Nodes - QuantEcon/sphinxcontrib-jupyter GitHub Wiki
Nodes from docutils (scroll down to see nodes added by sphinx and sphinxcontrib-jupyter)
| Elements | Links | Used In sphinxcontrib-jupyter |
|---|---|---|
| Structural Elements | ||
| document | doc, source | yes - (code) - same (html, ipynb) - same (pdf) |
| section | doc, source | yes - (html, ipynb, pdf) |
| topic | doc, source | yes - (html, ipynb, pdf) |
| sidebar | doc, source | no |
| Structural Subelements | ||
| title | doc, source | yes - (html, ipynb) - same (pdf) |
| subtitle | doc, source | no |
| decoration | doc, source | no |
| docinfo | doc, source | no |
| transition | doc, source | no |
| Bibliographic Elements | ||
| address | doc, source | no |
| author | doc, source | no |
| authors | doc, source | no |
| contact | doc, source | no |
| copyright | doc, source | no |
| date | doc, source | no |
| organization | doc, source | no |
| revision | doc, source | no |
| status | doc, source | no |
| version | doc, source | no |
| Decorative Elements | ||
| footer | doc, source | no |
| header | doc, source | no |
| Body Elements | ||
| Simple Body Elements | ||
| comment | doc, source | yes - (html, ipynb, pdf) |
| doctest_block | doc, source | |
| image | doc, source | yes - (html, ipynb) - same (pdf) |
| literal_block | doc, source | yes - (html, ipynb, pdf) - same (code) - code is the base for rest |
| math_block | doc, source | yes - (html, ipynb) - same (pdf) |
| paragraph | doc, source | yes - (html, ipynb, pdf) |
| pending | doc, source | no |
| raw | doc, source | yes - (html, ipynb) - same (pdf) |
| rubric | doc, source | yes - (html, ipynb, pdf) |
| substitution_definition | doc, source | no |
| target | doc, source | yes - (html, ipynb) - same (pdf) |
| Simple Body Subelements | ||
| attribution | doc, source | yes - (html, ipynb, pdf) |
| caption | doc, source | yes - (html, ipynb, pdf) |
| classifier | doc, source | no |
| colspec | doc, source | yes - (html, ipynb, pdf) (same) |
| field_name | doc, source | yes - (html, ipynb, pdf) (same) |
| label | doc, source | yes - (ipynb, pdf) - same (html) |
| line | doc, source | no |
| option_argument | doc, source | no |
| option_string | doc, source | no |
| term | doc, source | yes - (html, ipynb, pdf) (same) |
| Compound Body Elements | ||
| admonition | doc, source | no |
| attention | doc, source | no |
| block_quote | doc, source | yes - (html, ipynb, pdf) (same) |
| bullet_list | doc, source | yes - (html, ipynb) - same (pdf) |
| caution | doc, source | no |
| citation | doc, source | yes - (html, ipynb, pdf) (same) |
| compound | doc, source | no |
| container | doc, source | no |
| danger | doc, source | no |
| definition_list | doc, source | yes - (html, ipynb, pdf) (same) |
| enumerated_list | doc, source | yes - (html, ipynb, pdf) (same) |
| error | doc, source | no |
| field_list | doc, source | yes - (html, ipynb, pdf) (same) |
| figure | doc, source | yes - (html, ipynb, pdf) (same) |
| footnote | doc, source | yes - (html, ipynb, pdf) (same) |
| hint | doc, source | no |
| important | doc, source | no |
| line_block | doc, source | no |
| note | doc, source | yes - (html, ipynb, pdf) (same) |
| option_list | doc, source | no |
| system_message | doc, source | no |
| table | doc, source | yes - (html, ipynb, pdf) (same) |
| tip | doc, source | no |
| warning | doc, source | no |
| Compound Body Subelements | ||
| definition | doc, source | yes - (html, ipynb, pdf) (same) |
| definition_list_item | doc, source | no |
| description | doc, source | no |
| entry | doc, source | yes - (html, ipynb, pdf) (same) |
| field | doc, source | no |
| field_body | doc, source | yes - (html, ipynb, pdf) (same) |
| legend | doc, source | no |
| list_item | doc, source | yes - (html, ipynb, pdf) (same) |
| option | doc, source | no |
| option_group | doc, source | no |
| option_list_item | doc, source | no |
| row | doc, source | yes - (html, ipynb, pdf) (same) |
| tbody | doc, source | no |
| tgroup | doc, source | no |
| thead | doc, source | yes - (html, ipynb, pdf) (same) |
| Inline Elements | ||
| abbreviation | doc, source | no |
| acronym | doc, source | no |
| citation_reference | doc, source | no |
| emphasis | doc, source | yes - (html, ipynb, pdf) (same) |
| footnote_reference | doc, source | yes - (ipynb, pdf) - same (html) |
| generated | doc, source | no |
| inline | doc, source | no |
| literal | doc, source | yes - (html, ipynb, pdf) (same) |
| math | doc, source | yes - (html, ipynb) - same (pdf) |
| problematic | doc, source | no |
| reference | doc, source | yes - (html, ipynb, pdf) (all different) |
| strong | doc, source | yes - (html, ipynb, pdf) (same) |
| subscript | doc, source | no |
| substitution_reference | doc, source | no |
| superscript | doc, source | no |
| title_reference | doc, source | no |
Doctree node classes added by Sphinx
| Elements | Links | Used In sphinxcontrib-jupyter |
|---|---|---|
| domain-specific object description nodes | ||
| desc | doc, source | no |
| desc_signature | doc, source | no |
| desc_signature_line | doc, source | no |
| desc_addname | doc, source | no |
| desc_type | doc, source | no |
| desc_returns | doc, source | no |
| desc_name | doc, source | no |
| desc_parameterlist | doc, source | no |
| desc_parameter | doc, source | no |
| desc_optional | doc, source | no |
| desc_annotation | doc, source | no |
| desc_content | doc, source | no |
| New admonition-like constructs | ||
| versionmodified | doc, source | no |
| seealso | doc, source | no |
| Other paragraph-level nodes | ||
| compact_paragraph | doc, source | yes - (html, ipynb, pdf) (same) |
| New inline nodes | ||
| index | doc, source | no |
| pending_xref | doc, source | no |
| literal_emphasis | doc, source | no |
| abbreviation | doc, source | no |
| download_reference | doc, source | yes - (html, ipynb, pdf) (same) |
| Special nodes | ||
| only | doc, source | yes - (html, ipynb, pdf) (same) |
| meta | doc, source | no |
| highlightlang | doc, source | yes - (old code translator) |
| glossary | doc, source | no |
| toctree | doc, source | no |
| start_of_file | doc, source | no |
| productionlist | doc, source | no |
| production | doc, source | no |
Doctree node classes added by sphinxcontrib-jupyter
| Elements | Links |
|---|---|
| exercise | doc, source |
| exerciselist | doc, source |