diff --git a/docs/Makefile b/docs/Makefile index d0c3cbf..bb42adc 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -14,7 +14,20 @@ help: .PHONY: help Makefile +# Convert Markdown files to reStructuredText before building HTML +markdown_to_rst: + @echo "Converting Markdown files to reStructuredText" + @mkdir -p $(SOURCEDIR)/wiki/wiki_examples/selected_plots + @cp $(SOURCEDIR)/wiki_editable/wiki_examples/selected_plots/* $(SOURCEDIR)/wiki/wiki_examples/selected_plots/ + @find $(SOURCEDIR)/wiki_editable -name '*.md' -exec sh -c 'pandoc -f markdown -t rst "$$1" -o "$(SOURCEDIR)/wiki/$$(basename "$$1" .md).rst"' _ {} \; + @echo "Conversion complete." + # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile +html: markdown_to_rst @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +# # Catch-all target: route all unknown targets to Sphinx using the new +# # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +# %: Makefile +# @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt index cc5b4dc..a4150cd 100644 --- a/docs/build/html/_sources/index.rst.txt +++ b/docs/build/html/_sources/index.rst.txt @@ -21,6 +21,23 @@ GitHub QuaPy is hosted in GitHub at `https://github.com/HLT-ISTI/QuaPy `_ +Wiki Documents +------------ + +In this section you can find useful information concerning different aspects of QuaPy, with examples: + +.. toctree:: + :maxdepth: 1 + + wiki/Datasets + wiki/Evaluation + wiki/ExplicitLossMinimization + wiki/Methods + wiki/Model-Selection + wiki/Plotting + wiki/Protocols + + .. toctree:: :maxdepth: 2 :caption: Contents: diff --git a/docs/build/html/_sources/quapy.method.rst.txt b/docs/build/html/_sources/quapy.method.rst.txt index 8026e0a..31a357a 100644 --- a/docs/build/html/_sources/quapy.method.rst.txt +++ b/docs/build/html/_sources/quapy.method.rst.txt @@ -52,6 +52,14 @@ quapy.method.non\_aggregative module :undoc-members: :show-inheritance: +quapy.method.composable module +------------------------ + +.. automodule:: quapy.method.composable + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 0099e44..7dcd630 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -43,6 +43,15 @@