Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
A
ansible
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
OpenEdx
ansible
Commits
1713013d
Commit
1713013d
authored
Dec 25, 2013
by
Mikhail Sobolev
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
provide sections and local TOC for module documentation
parent
7965d331
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
20 additions
and
5 deletions
+20
-5
hacking/templates/rst.j2
+20
-5
No files found.
hacking/templates/rst.j2
View file @
1713013d
...
@@ -2,6 +2,13 @@
...
@@ -2,6 +2,13 @@
@{ module }@
@{ module }@
++++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++
{% if author %}
:Author: @{ author }@
{% endif %}
.. contents::
:local:
:depth: 1
{# ------------------------------------------
{# ------------------------------------------
#
#
...
@@ -10,6 +17,9 @@
...
@@ -10,6 +17,9 @@
#
#
--------------------------------------------#}
--------------------------------------------#}
Synopsis
--------
{% if version_added is defined -%}
{% if version_added is defined -%}
.. versionadded:: @{ version_added }@
.. versionadded:: @{ version_added }@
{% endif %}
{% endif %}
...
@@ -19,6 +29,9 @@
...
@@ -19,6 +29,9 @@
{% endfor %}
{% endfor %}
{% if options -%}
{% if options -%}
Options
-------
.. raw:: html
.. raw:: html
<table border=1 cellpadding=4>
<table border=1 cellpadding=4>
...
@@ -54,7 +67,10 @@
...
@@ -54,7 +67,10 @@
{% endfor %}
{% endfor %}
{% endif %}
{% endif %}
{% if not plainexamples %}
{% if examples or plainexamples %}
Examples
--------
.. raw:: html
.. raw:: html
{% for example in examples %}
{% for example in examples %}
...
@@ -66,19 +82,18 @@
...
@@ -66,19 +82,18 @@
</p>
</p>
{% endfor %}
{% endfor %}
<br/>
<br/>
{% endif %}
{% if plainexamples %}
{% if plainexamples %}
Examples
::
::
@{ plainexamples | escape | indent(4, True) }@
@{ plainexamples | escape | indent(4, True) }@
{% endif %}
{% endif %}
{% endif %}
{% if notes %}
{% if notes %}
{% for note in notes %}
{% for note in notes %}
.. note:: @{ note |
html_ify }@</p>
.. note:: @{ note |
convert_symbols_to_format }@
{% endfor %}
{% endfor %}
{% endif %}
{% endif %}
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment