Closes #2 (build folder is now provided by sphinx)
Closes #15 (we can now start with non-existing folders when creating data cards)
Closes #16 (the waveform plots are now stored in the corresponding data card folders)
Adds the sphinx extension audbcards.sphinx, to create data card pages without writing any code.
Also adds documentation that uses the new extension and creates example datasets pages.
Under the hood a few changes are applied to audbcards.Datacard:
Renamed Datacard.example to Datacard.example_media
Added the boolean Datacard.example and the argument example to Datacard to define if an audio example should be added to the card
Added Datacard.sphinx_build_dir and the argument sphinx_build_dir to Datacard() to specify the build dir of sphinx. Default is set to None, which is useful if the class should be used outside of the new audbcards.sphinx extension
Added Datacard.sphinx_src_dir and the argument sphinx_src_dir to Datacard() to specify the source dir of sphinx. Default is set to None, which is useful if the class should be used outside of the new audbcards.sphinx extension
Closes #2 (build folder is now provided by
sphinx) Closes #15 (we can now start with non-existing folders when creating data cards) Closes #16 (the waveform plots are now stored in the corresponding data card folders)Adds the sphinx extension
audbcards.sphinx, to create data card pages without writing any code. Also adds documentation that uses the new extension and creates example datasets pages.Under the hood a few changes are applied to
audbcards.Datacard:Datacard.exampletoDatacard.example_mediaDatacard.exampleand the argumentexampletoDatacardto define if an audio example should be added to the cardDatacard.sphinx_build_dirand the argumentsphinx_build_dirtoDatacard()to specify the build dir of sphinx. Default is set toNone, which is useful if the class should be used outside of the newaudbcards.sphinxextensionDatacard.sphinx_src_dirand the argumentsphinx_src_dirtoDatacard()to specify the source dir of sphinx. Default is set toNone, which is useful if the class should be used outside of the newaudbcards.sphinxextensionDocumentation
Example datasets pages