Commit dcdf8195 authored by Mihai Baltac's avatar Mihai Baltac
Browse files

small changes package/module documentation templates

parent f58dceeb
Pipeline #24923 passed with stages
in 4 minutes and 33 seconds
rm -rf docs/build docs/source/mod rm -rf docs/build docs/source/mod
python docs/better_apidoc.py -l -e -d 2 -t docs/generation-templates -o docs/source/mod nifty4 python docs/better_apidoc.py -l -e -d 3 -t docs/generation-templates -o docs/source/mod nifty4
sphinx-build -b html docs/source/ docs/build/ sphinx-build -b html docs/source/ docs/build/
...@@ -18,9 +18,11 @@ ...@@ -18,9 +18,11 @@
Summary Summary
------- -------
{% if doc:%}
{%- if doc:%}
Description:
{{doc}} {{doc}}
{% endif %} {%- endif %}
{%- if exceptions %} {%- if exceptions %}
......
...@@ -20,7 +20,8 @@ ...@@ -20,7 +20,8 @@
{% if submodules %} {% if submodules %}
Submodules: Submodules
----------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
...@@ -32,7 +33,8 @@ ...@@ -32,7 +33,8 @@
{% if subpackages %} {% if subpackages %}
Subpackages: Subpackages
-----------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
...@@ -46,9 +48,10 @@ ...@@ -46,9 +48,10 @@
{% if members or doc %} {% if members or doc %}
Summary Summary
------- -------
{% if doc:%} {%- if doc:%}
Description:
{{doc}} {{doc}}
{% endif %} {%- endif %}
{%- if exceptions %} {%- if exceptions %}
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment