diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fcf306e..7fcecff 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -45,10 +45,6 @@ jobs: pre-build-command: | python -m pip install --upgrade pip setuptools wheel python -m pip install -e .[docs] - mkdir -p docs/source/wiki/wiki_examples/selected_plots - cp docs/source/wiki_editable/wiki_examples/selected_plots/* docs/source/wiki/wiki_examples/selected_plots/ - find docs/source/wiki_editable -name '*.md' -exec sh -c 'pandoc -f markdown -t rst "$$1" -o "docs/source/wiki/$$(basename "$$1" .md).rst"' _ {} \; - sphinx-apidoc --force --output-dir docs/source quapy docs-folder: "docs/" - name: Publish documentation run: | diff --git a/docs/.gitignore b/docs/.gitignore index 4b7ed84..567609b 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1 @@ build/ -source/wiki/ diff --git a/docs/Makefile b/docs/Makefile index bb42adc..d0c3cbf 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -14,20 +14,7 @@ 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). -html: markdown_to_rst +%: Makefile @$(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/source/.gitignore b/docs/source/.gitignore new file mode 100644 index 0000000..dab1498 --- /dev/null +++ b/docs/source/.gitignore @@ -0,0 +1 @@ +!*.png \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 01c305d..9d86c63 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -35,9 +35,12 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.viewcode', - 'sphinx.ext.napoleon' + 'sphinx.ext.napoleon', + 'myst_parser', ] +source_suffix = ['.rst', '.md'] + templates_path = ['_templates'] # List of patterns, relative to source directory, that match files and diff --git a/docs/source/wiki_editable/Datasets.md b/docs/source/wiki/Datasets.md similarity index 100% rename from docs/source/wiki_editable/Datasets.md rename to docs/source/wiki/Datasets.md diff --git a/docs/source/wiki_editable/Evaluation.md b/docs/source/wiki/Evaluation.md similarity index 100% rename from docs/source/wiki_editable/Evaluation.md rename to docs/source/wiki/Evaluation.md diff --git a/docs/source/wiki_editable/ExplicitLossMinimization.md b/docs/source/wiki/ExplicitLossMinimization.md similarity index 100% rename from docs/source/wiki_editable/ExplicitLossMinimization.md rename to docs/source/wiki/ExplicitLossMinimization.md diff --git a/docs/source/wiki_editable/Methods.md b/docs/source/wiki/Methods.md similarity index 100% rename from docs/source/wiki_editable/Methods.md rename to docs/source/wiki/Methods.md diff --git a/docs/source/wiki_editable/Model-Selection.md b/docs/source/wiki/Model-Selection.md similarity index 100% rename from docs/source/wiki_editable/Model-Selection.md rename to docs/source/wiki/Model-Selection.md diff --git a/docs/source/wiki_editable/Plotting.md b/docs/source/wiki/Plotting.md similarity index 100% rename from docs/source/wiki_editable/Plotting.md rename to docs/source/wiki/Plotting.md diff --git a/docs/source/wiki_editable/Protocols.md b/docs/source/wiki/Protocols.md similarity index 100% rename from docs/source/wiki_editable/Protocols.md rename to docs/source/wiki/Protocols.md diff --git a/docs/source/wiki_editable/wiki_examples/selected_plots/bin_bias.png b/docs/source/wiki/wiki_examples/selected_plots/bin_bias.png similarity index 100% rename from docs/source/wiki_editable/wiki_examples/selected_plots/bin_bias.png rename to docs/source/wiki/wiki_examples/selected_plots/bin_bias.png diff --git a/docs/source/wiki_editable/wiki_examples/selected_plots/bin_bias_bin_cc.png b/docs/source/wiki/wiki_examples/selected_plots/bin_bias_bin_cc.png similarity index 100% rename from docs/source/wiki_editable/wiki_examples/selected_plots/bin_bias_bin_cc.png rename to docs/source/wiki/wiki_examples/selected_plots/bin_bias_bin_cc.png diff --git a/docs/source/wiki_editable/wiki_examples/selected_plots/bin_bias_cc.png b/docs/source/wiki/wiki_examples/selected_plots/bin_bias_cc.png similarity index 100% rename from docs/source/wiki_editable/wiki_examples/selected_plots/bin_bias_cc.png rename to docs/source/wiki/wiki_examples/selected_plots/bin_bias_cc.png diff --git a/docs/source/wiki_editable/wiki_examples/selected_plots/bin_diag.png b/docs/source/wiki/wiki_examples/selected_plots/bin_diag.png similarity index 100% rename from docs/source/wiki_editable/wiki_examples/selected_plots/bin_diag.png rename to docs/source/wiki/wiki_examples/selected_plots/bin_diag.png diff --git a/docs/source/wiki_editable/wiki_examples/selected_plots/bin_diag_cc.png b/docs/source/wiki/wiki_examples/selected_plots/bin_diag_cc.png similarity index 100% rename from docs/source/wiki_editable/wiki_examples/selected_plots/bin_diag_cc.png rename to docs/source/wiki/wiki_examples/selected_plots/bin_diag_cc.png diff --git a/docs/source/wiki_editable/wiki_examples/selected_plots/err_drift.png b/docs/source/wiki/wiki_examples/selected_plots/err_drift.png similarity index 100% rename from docs/source/wiki_editable/wiki_examples/selected_plots/err_drift.png rename to docs/source/wiki/wiki_examples/selected_plots/err_drift.png diff --git a/setup.py b/setup.py index d0f299a..5c0dd2d 100644 --- a/setup.py +++ b/setup.py @@ -127,7 +127,7 @@ setup( 'bayes': ['jax', 'jaxlib', 'numpyro'], 'composable': ['qunfold @ git+https://github.com/mirkobunse/qunfold@v0.1.3'], 'tests': ['certifi'], - 'docs' : ['sphinx-rtd-theme'], + 'docs' : ['sphinx-rtd-theme', 'myst-parser', 'qunfold @ git+https://github.com/mirkobunse/qunfold@v0.1.3'], }, # If there are data files included in your packages that need to be