From bb95ed1de0e50422fb704d217e11245793b0bdc5 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sun, 20 Dec 2020 22:33:42 -0800 Subject: [PATCH] Make it possible to have Plugin readmes in the plugin dirs --- docs/Makefile | 5 +++++ .../__pycache__/copy-examples.cpython-39.pyc | Bin 0 -> 2488 bytes .../copy-plugin-readmes.cpython-39.pyc | Bin 0 -> 502 bytes docs/_sphinx/copy-plugin-readmes.py | 11 +++++++++++ docs/conf.py | 1 + 5 files changed, 17 insertions(+) create mode 100644 docs/_sphinx/__pycache__/copy-examples.cpython-39.pyc create mode 100644 docs/_sphinx/__pycache__/copy-plugin-readmes.cpython-39.pyc create mode 100644 docs/_sphinx/copy-plugin-readmes.py 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 0000000000000000000000000000000000000000..54eeea7876b6d0f5160cb1b2376900f19d6e20a7 GIT binary patch literal 2488 zcmb7GTW=gS6rP#AW|Oq2R44)-Eb*}2Rd!~Rl+cD!wX~&FtwKavBvwKr@7TNJ#xq`Q zPtq-02?<{L2RyVdNc|i93+90bctHFGo;dc*Ubv`&QP$(j@j1ue_xVil=4Q)*=lh?2 z4j(lg=T|dWeLNW4fS-z?A2$W2kX#pkmk3}V1ulY7Q8pfI@y5tIpQ5Voz1LQbDUc;BNQD^VwOHZ z^ogdaVj@K&Az_4*38xAX5oHNYHP*1?w^~2GM7#Z+tLO-4935h>5E>Z|ufTX4Ny-83Q@WClUplxq zLQ|1Rq@al?Bn$j8g*aveiA*ETPUt~lTkhzg4{sjd3Ca;dJ;Ug7XeJ70t8-?y1Y%`l zG7S?!GEP@bdngQ9%5)e4Y765sjxUui=E{{{zWxDdPZ#nE%Y&#`WSpQOEl*(0=lIQy zK0s~X58!W+NP7o1r!Lw9poJMrp>T)DF7iS=eQU;4u z2n0fq$e5;7Vok{+1vr|dD&ty#uOcX%$Ed2z1H{#~To?jM%varvSW3cWAQ7oc9W+`22xWmmhc!J z2$M9@Lc;wmok^OAQ{WtDS|lKc2y;I5!P7n6RyLf5jg-8PhL~81voSiwJcCMi#vsE8 zXNn@FB~Hgs8EA}88Qe8U?surq&SA&Rn@4bgAHYR}e%16lmAnS%PIvRBd1*;$UYCh^ zgUNZ&mCjViv=NMuk*WCerwSb?#7+c1bp(xe9y{87>^-l{pxVFih({{ldAFS}cAt5= zI`h79-D15q^Io`WYvw(xz3a7d5_dI&g=m{ASoR%-@)ilex2VYFnZuw@K1jSC5aO;^b%1WvlJ zj*EK_97Hi-+wOLQuk7Gi+qV%Eg#tt7&J@JA9=8E=xOu1x6@E;$b+>KPn(G8%_$W~o zNj5Y@4}tHZIzIKf-G>198i*p33JU09r=C~GTnuwhsJv=2&a00FOY_=9vQ+0arXb%= zb5a;U-#t9ap{q8~>g}O;J$beOQ?Xe-rwh^LZl-p-P3JTr<1Ov82f^Zy35b z8%l!=oHWifEp<8(#B#v+^ehG0&9% literal 0 HcmV?d00001 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 0000000000000000000000000000000000000000..905460aaa08fe7512e55bcce47a0f0de2edc23ed GIT binary patch literal 502 zcmZvZu};G<5Qc3hO{z*oj7-RDhLjgT2&sFQZe6S>cEKWXEZdRVijfCtM_z!p-~}=v zG4Tpa+__YA;G#RBB^8zT~V3H^o6XL z9LWsUM6x9*^4)Cida3x*K5Db!Y7><4x-&d<-1UZ6yse(pS~rUOpzP!esAN&2$|9R(EEt zA6|*e0QY?@d~|p74`61u!}PdaXrqIYIogQ+s2f9HQz)mvK81{4FQIuRd-y_u9@wAT zUtW3SfvFq>jH*NA71SXiT00h097bM+-r~PGiDO@+LoS5uY9SnYiUfyG&d%dYx(FHH Rww>%7b%#DZ-cOS;Tt6bmZKD7H literal 0 HcmV?d00001 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