More sophisticated markup techniques
There are some additional markup techniques that can make a document easier to read. In particular, we often want useful cross-references between class definitions. We may also want cross-references between sections and topics within a document.
In pure RST (that is, without Sphinx), we need to provide proper URLs that reference different sections of our documents. We have three kinds of references:
- Implicit references to section titles: We can use
`Some Heading`_
to refer to theSome Heading
section. This will work for all the headings that docutils recognizes. - Explicit references to targets: We can use
target_
to reference the location of_target
in the document. - Inter-document references: We have to create a ...
Get Mastering Object-oriented Python now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.