diff --git a/docs/Makefile b/docs/Makefile index 00cd50de..14b083cc 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -18,6 +18,11 @@ clean: rm -rf doxyoutput/ api/ @$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) +copy-plugin-readmes: + install -d plugins + (cd ../plugins; \ + ls -d * |xargs -n 1 -I % cp %/README.md ../docs/plugins/%.md ) + examples: install -d examples diff --git a/docs/_sphinx/__pycache__/copy-examples.cpython-39.pyc b/docs/_sphinx/__pycache__/copy-examples.cpython-39.pyc new file mode 100644 index 00000000..54eeea78 Binary files /dev/null and b/docs/_sphinx/__pycache__/copy-examples.cpython-39.pyc differ diff --git a/docs/_sphinx/__pycache__/copy-plugin-readmes.cpython-39.pyc b/docs/_sphinx/__pycache__/copy-plugin-readmes.cpython-39.pyc new file mode 100644 index 00000000..905460aa Binary files /dev/null and b/docs/_sphinx/__pycache__/copy-plugin-readmes.cpython-39.pyc differ diff --git a/docs/_sphinx/copy-plugin-readmes.py b/docs/_sphinx/copy-plugin-readmes.py new file mode 100644 index 00000000..fb99c452 --- /dev/null +++ b/docs/_sphinx/copy-plugin-readmes.py @@ -0,0 +1,11 @@ +"""Crude Sphinx extension to run a makefile step +""" + +import os + + +def config_inited(app, config): + os.system('make copy-plugin-readmes') + +def setup(app): + app.connect('config-inited', config_inited) diff --git a/docs/conf.py b/docs/conf.py index 0274704d..42a15338 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -37,6 +37,7 @@ extensions = [ ] extensions.append('copy-examples') +extensions.append('copy-plugin-readmes') # Setup the breathe extension