module.rst 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. {{ fullname | escape | underline}}
  2. {{ release }}
  3. .. automodule:: {{ fullname }}
  4. {% block attributes %}
  5. {% if attributes %}
  6. .. rubric:: Module Attributes
  7. .. autosummary::
  8. :toctree:
  9. {% for item in attributes %}
  10. {{ item }}
  11. {%- endfor %}
  12. {% endif %}
  13. {% endblock %}
  14. {% block functions %}
  15. {% if functions %}
  16. .. rubric:: {{ _('Functions') }}
  17. .. autosummary::
  18. :toctree:
  19. {% for item in functions %}
  20. {{ item }}
  21. {%- endfor %}
  22. {% endif %}
  23. {% endblock %}
  24. {% block classes %}
  25. {% if classes %}
  26. .. rubric:: {{ _('Classes') }}
  27. .. autosummary::
  28. :toctree:
  29. :template: custom_autosummary/class.rst
  30. {% for item in classes %}
  31. {{ item }}
  32. {%- endfor %}
  33. {% endif %}
  34. {% endblock %}
  35. {% block exceptions %}
  36. {% if exceptions %}
  37. .. rubric:: {{ _('Exceptions') }}
  38. .. autosummary::
  39. :toctree:
  40. {% for item in exceptions %}
  41. {{ item }}
  42. {%- endfor %}
  43. {% endif %}
  44. {% endblock %}
  45. {% block modules %}
  46. {% if modules %}
  47. .. rubric:: Modules
  48. .. autosummary::
  49. :toctree:
  50. :template: custom_autosummary/module.rst
  51. :recursive:
  52. {% for item in modules %}
  53. {{ item }}
  54. {%- endfor %}
  55. {% endif %}
  56. {% endblock %}