xref: /aosp_15_r20/external/pigweed/pw_module/py/pw_module/templates/docs.rst.jinja (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1{#
2Copyright 2024 The Pigweed Authors
3
4Licensed under the Apache License, Version 2.0 (the "License"); you may not
5use this file except in compliance with the License. You may obtain a copy of
6the License at
7
8    https://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13License for the specific language governing permissions and limitations under
14the License.
15#}
16.. _module-{{ module.name }}:
17
18{{ module.name.header_line }}
19{{ module.name }}
20{{ module.name.header_line }}
21.. pigweed-module::
22   :name: {{ module.name }}
23
24.. Please update //docs/module_metadata.json
25   according to the schema in //docs/module_metadata_schema.json
26.. Follow the guidance in pigweed.dev/docs/contributing/docs/modules.html
27