mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
f57177de89
- Add entries in the table of contents for domain objects (e.g. `py:function`, `rst:role`, etc). Supported domains are Javascript, Python, and reStructuredText. - Support content in `py:module` and `js:module` directives. - Add the `noindexentry` and `noindex` flags to more domains. - Add `toc_object_entries_show_parents` configuration setting - Update documentation and tests
39 lines
731 B
ReStructuredText
39 lines
731 B
ReStructuredText
test-domain-objects
|
|
===================
|
|
|
|
.. py:module:: hello
|
|
|
|
.. py:function:: world() -> str
|
|
|
|
Prints "Hello, World!" to stdout
|
|
|
|
.. py:class:: HelloWorldPrinter
|
|
|
|
Controls printing of hello world
|
|
|
|
.. py:method:: set_language()
|
|
|
|
Sets the language of the HelloWorldPrinter instance
|
|
|
|
.. py:attribute:: output_count
|
|
|
|
Count of outputs of "Hello, World!"
|
|
|
|
.. py:method:: print_normal()
|
|
:async:
|
|
:classmethod:
|
|
|
|
Prints the normal form of "Hello, World!"
|
|
|
|
.. py:method:: print()
|
|
|
|
Prints "Hello, World!", including in the chosen language
|
|
|
|
.. py:function:: exit()
|
|
:module: sys
|
|
|
|
Quits the interpreter
|
|
|
|
.. js:function:: fetch(resource)
|
|
|
|
Fetches the given resource, returns a Promise |