diff --git a/docs/_templates/datacard_header.j2 b/docs/_templates/datacard_header.j2 new file mode 100644 index 0000000..43fc507 --- /dev/null +++ b/docs/_templates/datacard_header.j2 @@ -0,0 +1,31 @@ +.. _{{ path }}-{{ name }}: + +{{ name }} +{% for n in range(name|length) %}-{% endfor %} + +{% if author is not none %} + +Created by {{ author }} +{% endif %} + +============= ====================== +version {{ version }} +{% if license_link is not none %} +license `{{ license }} <{{ license_link }}>`__ +{% else %} +license {{ license }} +{% endif %} +usage {{ usage }} +{% if languages is defined %} +languages {{ languages|join(', ') }} +{% endif %} +format {{ formats|join(', ') }} +channel {{ channels|join(', ') }} +sampling rate {{ sampling_rates|join(', ') }} +bit depth {{ bit_depths|join(', ') }} +duration {{ duration }} +files {{ files }}, duration distribution: {{ file_duration_distribution }} +{% if segments != "0" %} +segments {{ segments }}, duration distribution: {{ segment_duration_distribution }} +{% endif %} +============= ====================== diff --git a/docs/conf.py b/docs/conf.py index 74bdc2b..b100499 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -33,6 +33,7 @@ "display_version": True, "logo_only": False, "footer_links": False, + "wide_pages": ["datasets"], } html_context = { "display_github": True, @@ -47,3 +48,4 @@ True, # don't show audio examples ), ] +audbcards_templates = "_templates" diff --git a/docs/requirements.txt b/docs/requirements.txt index ef5c121..a947849 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ audb >=1.10.2 -audbcards >= 0.3.2 +audbcards >= 0.3.3 audplot sphinx sphinx-audeering-theme >=1.2.1