Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
ift
NIFTy
Commits
fc3fa74e
Commit
fc3fa74e
authored
Feb 14, 2018
by
Mihai Baltac
Browse files
small changes package/module documentation templates
parent
dcdf8195
Changes
2
Hide whitespace changes
Inline
Side-by-side
docs/generation-templates/module.rst
View file @
fc3fa74e
...
@@ -7,6 +7,11 @@
...
@@ -7,6 +7,11 @@
({{ fullname }} module)
({{ fullname }} module)
{% endif %}
{% endif %}
{%- if doc %}
{{doc}}
{%- endif %}
.. currentmodule:: {{ fullname }}
.. currentmodule:: {{ fullname }}
.. automodule:: {{ fullname }}
.. automodule:: {{ fullname }}
...
@@ -19,11 +24,6 @@
...
@@ -19,11 +24,6 @@
Summary
Summary
-------
-------
{%- if doc:%}
Description:
{{doc}}
{%- endif %}
{%- if exceptions %}
{%- if exceptions %}
Exceptions:
Exceptions:
...
...
docs/generation-templates/package.rst
View file @
fc3fa74e
...
@@ -2,13 +2,16 @@
...
@@ -2,13 +2,16 @@
{{ name }}
{{ name }}
{% for item in range(8 + name|length) -%}={%- endfor %}
{% for item in range(8 + name|length) -%}={%- endfor %}
({{ fullname }} package)
({{ fullname }} package)
{% else %}
{% else %}
{{ fullname }}
{{ fullname }}
{% for item in range(8 + fullname|length) -%}={%- endfor %}
{% for item in range(8 + fullname|length) -%}={%- endfor %}
({{ fullname }} package)
({{ fullname }} package)
{% endif %}
{% endif %}
{%- if doc %}
{{doc}}
{%- endif %}
.. automodule:: {{ fullname }}
.. automodule:: {{ fullname }}
{% if members -%}
{% if members -%}
:members: {{ members|join(", ") }}
:members: {{ members|join(", ") }}
...
@@ -17,8 +20,6 @@
...
@@ -17,8 +20,6 @@
{%- endif %}
{%- endif %}
{% if submodules %}
{% if submodules %}
Submodules
Submodules
----------
----------
...
@@ -45,13 +46,9 @@
...
@@ -45,13 +46,9 @@
{%- endif %}
{%- endif %}
{% if members
or doc
%}
{% if members %}
Summary
Summary
-------
-------
{%- if doc:%}
Description:
{{doc}}
{%- endif %}
{%- if exceptions %}
{%- if exceptions %}
...
...
Write
Preview
Supports
Markdown
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