Skip to content

Explain function and module directives in API doc best practices #3038

Open
@patiencedaur

Description

@patiencedaur

Consider explaining how the .. function:: and .. module:: directives work, specifically that they don't produce headings displayed in the right menu. This means that each new function section should start with an .. _anchor:, which should do either of the following:

  • Be linked to in the "List of all functions"/"Index" section on the module page. This way the reader can follow the link to go to the desired page.
  • Be put in the hidden .. toctree:: on the module page. This way the link to a specific function API appears in the left menu in the tree.

Follow-up to #3024

Originally posted by @patiencedaur in #3024 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    guidelinesreference[location] Tarantool manual, Reference part

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions