Table of Contents
This is the “documentation” for the sphinx_readme
test package.
Here, you can compare the HTML rendering and the output generated by sphinx_readme
.
Below are toctrees that cover all files in the tests/datasets
directory.
- Admonitions
- Rubrics
- Basic Toctree
- Max Depth Toctree
- Titles Only Toctree
- Python Domain - Non-External Cross-References
:mod:
- Long Cross-References:mod:
- Short Cross-References:mod:
- Explicit Title Cross-References:data:
- Long Cross-References:data:
- Short Cross-References:data:
- Explicit Title Cross-References:func:
- Long Cross-References:func:
- Short Cross-References:func:
- Explicit Title Cross-References:exc:
- Long Cross-References:exc:
- Short Cross-References:exc:
- Explicit Title Cross-References:class:
- Long Cross-References:class:
- Short Cross-References:class:
- Explicit Title Cross-References:meth:
- Long Cross-References:meth:
- Short Cross-References:meth:
- Explicit Title Cross-References:attr:
- Attribute Long Cross-References:attr:
- Attribute Short Cross-References:attr:
- Attribute Explicit Title Cross-References:attr:
- Property Long Cross-References:attr:
- Property Short Cross-References:attr:
- Property Explicit Title Cross-References:attr:
- Cached Property Long Cross-References:attr:
- Cached Property Short Cross-References:attr:
- Cached Property Explicit Title Cross-References
- Cross-References in Substitution Definitions