From ec99397c3ea057903fba8cf12e1360df0727baae Mon Sep 17 00:00:00 2001 From: Krzysztof Date: Sun, 23 Oct 2016 22:14:24 +0200 Subject: [PATCH] Initial Sphinx / ReadTheDocs.org configuration --- docs/Doxyfile | 12 ++ docs/Makefile | 177 +++++++++++++++++++++++++++ docs/_static/1.png | Bin 0 -> 11412 bytes docs/conf.py | 270 ++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 88 ++++++++++++++ docs/requirements.txt | 1 + 6 files changed, 548 insertions(+) create mode 100644 docs/Doxyfile create mode 100644 docs/Makefile create mode 100644 docs/_static/1.png create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/requirements.txt diff --git a/docs/Doxyfile b/docs/Doxyfile new file mode 100644 index 0000000000..795bfa5e89 --- /dev/null +++ b/docs/Doxyfile @@ -0,0 +1,12 @@ +PROJECT_NAME = "ESP32 Programming Guide" +XML_OUTPUT = xml +GENERATE_LATEX = NO +GENERATE_MAN = NO +GENERATE_RTF = NO +CASE_SENSE_NAMES = NO +INPUT = ../components/driver/include +RECURSIVE = YES +QUIET = YES +JAVADOC_AUTOBRIEF = YES +GENERATE_HTML = NO +GENERATE_XML = YES \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000000..c04268ff1d --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/ReadtheDocsTemplate" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ReadtheDocsTemplate" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/_static/1.png b/docs/_static/1.png new file mode 100644 index 0000000000000000000000000000000000000000..4920892781f90c3db323f82033866c3f7116c073 GIT binary patch literal 11412 zcmV;FENjz=P)KLZ*U+5Lu!Sk^o_Z5E4Meg@_7P6crJiNL9pw)e1;Xm069{HJUZAPk55R%$-RIA z6-eL&AQ0xu!e<4=008gy@A0LT~suv4>S3ILP<0Bm`DLLvaF4FK%)Nj?Pt*r}7;7Xa9z9H|HZjR63e zC`Tj$K)V27Re@400>HumpsYY5E(E}?0f1SyGDiY{y#)Yvj#!WnKwtoXnL;eg03bL5 z07D)V%>y7z1E4U{zu>7~aD})?0RX_umCct+(lZpemCzb@^6=o|A>zVpu|i=NDG+7} zl4`aK{0#b-!z=TL9Wt0BGO&T{GJWpjryhdijfaIQ&2!o}p04JRKYg3k&Tf zVxhe-O!X z{f;To;xw^bEES6JSc$k$B2CA6xl)ltA<32E66t?3@gJ7`36pmX0IY^jz)rRYwaaY4 ze(nJRiw;=Qb^t(r^DT@T3y}a2XEZW-_W%Hszxj_qD**t_m!#tW0KDiJT&R>6OvVTR z07RgHDzHHZ48atvzz&?j9lXF70$~P3Knx_nJP<+#`N z#-MZ2bTkiLfR>_b(HgWKJ%F~Nr_oF3b#wrIijHG|(J>BYjM-sajE6;FiC7vY#};Gd zST$CUHDeuEH+B^pz@B062qXfFfD`NpUW5?BY=V%GM_5c)L#QR}BeW8_2v-S%gfYS= zB9o|3v?Y2H`NVi)In3rTB8+ej^> zQ=~r95NVuDChL%G$=>7$vVg20myx%S50Foi`^m%Pw-h?Xh~i8Mq9jtJloCocWk2Nv zrJpiFnV_ms&8eQ$2&#xWpIS+6pmtC%Q-`S&GF4Q#^mhymh7E(qNMa}%YZ-ePrx>>xFPTiH1=E+A$W$=bG8>s^ zm=Bn5Rah$aDtr}@$`X}2l~$F0mFKEdRdZE8)p@E5RI61Ft6o-prbbn>P~)iy)E2AN zsU20jsWz_8Qg>31P|s0cqrPALg8E|(vWA65poU1JRAaZs8I2(p#xiB`SVGovRs-uS zYnV-9TeA7=Om+qP8+I>yOjAR1s%ETak!GFdam@h^# z)@rS0t$wXH+Irf)+G6c;?H29p+V6F6oj{!|o%K3xI`?%6x;DB|x`n#ibhIR?(H}Q3Gzd138Ei2)WAMz7W9Vy`X}HnwgyEn!VS)>mv$8&{hQn>w4zwy3R}t;BYlZQm5)6pty=DfLrs+A-|>>;~;Q z_F?uV_HFjh9n2gO9o9Q^JA86v({H5aB!kjoO6 zc9$1ZZKsN-Zl8L~mE{`ly3)1N^`o1+o7}D0ZPeY&J;i;i`%NyJ8_8Y6J?}yE@b_5a zam?eLr<8@mESk|3$_SkmS{wQ>%qC18))9_|&j{ZT zes8AvOzF(F2#DZEY>2oYX&IRp`F#{ADl)1r>QS^)ba8a|EY_^#S^HO&t^Rgqwv=MZThqqEWH8 zxJo>d=ABlR_Bh=;eM9Tw|Ih34~oTE|= zX_mAr*D$vzw@+p(E0Yc6dFE}(8oqt`+R{gE3x4zjX+Sb3_cYE^= zgB=w+-tUy`ytONMS8KgRef4hA?t0j zufM;t32jm~jUGrkaOInTZ`zyfns>EuS}G30LFK_G-==(f<51|K&cocp&EJ`SxAh3? zNO>#LI=^+SEu(FqJ)ynt=!~PC9bO$rzPJB=?=j6w@a-(u02P7 zaQ)#(uUl{HW%tYNS3ItC^iAtK(eKlL`f9+{bJzISE?u8_z3;~C8@FyI-5j_jy7l;W z_U#vU3hqqYU3!mrul&B+{ptt$59)uk{;_4iZQ%G|z+lhASr6|H35TBkl>gI*;nGLU zN7W-nBaM%pA0HbH8olyl&XeJ%vZoWz%6?Y=dFykl=imL}`%BMQ{Mhgd`HRoLu6e2R za__6DuR6yg#~-}Tc|Gx_{H@O0eebyMy5GmWADJlpK>kqk(fVV@r_fLLKIeS?{4e)} z^ZO;zpECde03c&XQcVB=dL;k=fP(-4`Tqa_faw4Lbua(`>RI+y?e7jKeZ#YO-C zA;C#RK~#9!?45U%6;<-bKl2zEP!JSJCZZSsQIMb_VP$bKjIyAptZNp~pE-*n>WVpM zU0kywtir50Ek=x}C_x2@DnW8`2s6Jws@`E1nb-GrxZUr~`=0ZTN2bH=?r-0&TlKA~ zg7M?WlZR8B4Gafr1KVun?<;}dfpx$VU=gqYSg5~WfS>fYq^jS{;^N|re=p4Q%{k5m z8fN(WcKQQo>T#@Pz*Jxw@GbBq@HMa|f1C3Jj{_Zn)*&8md*C4brBSAY{}A{H_yCxl zCwLw%aDsz#q<}X18?68K6YvJ`7VwUmK~(~&Jm;L^sF=>%0vHOs2rLF(1?c;T;LQ^}4`a*+F3`nblAeDb;7P{v<-U}>E(D>>C{|8I~UIYG|CwLxyF$r-O?gR`%JRV8HUw}7(&w-Rx`(H{iXCTM*711~Aj|CA?qcAz#eOuY%;0#5@Mt1a3n#&Jyr&H{GP@yt%pJ?n_L z7hhEqD{D|tg+le!fYX8Nfd(12TL4T(B7$E7Ujg3(<&MW&2=oUo1v(_?K9=jE^a{ia z6Dzzz^;KmC@2Nz6$b;MfjdeD^RLzHJNJ#t*eK~sL#-+9q7_GBsAK>kzOp3rs`qE!W z!h?mmPVmOSGr)g=b^$#MeSoWwXy9_-JzxaT)xmvyOT8Kg=!=#F)B$b>K1nTb<1>Bq6?YR|M}4JinFmg+=n+ zfOmmAfm#WgKIt|Te7RcwhtllO;hXwyblZ^ zyU`H1OwE_))t(Lu@2ZDmB(N#QYpenM3%ErWqd7tF0$p60e4d_0Le!>_!VXC8VP|p& z)qsJ(r-;uxEOVk-*dh zM1&Ov(zft*G0*1x^ab7_n+e_vxY=O4iHJMR=7x7g#8OoOJ=6?)1!y0_@iyopw>vN= z#_KvzC#eS6NbttMa|XwqiTK6Wl7|-#Lv%EcBl_{6_*h?<=VH93wn(=B&e=rp6r%g^ zlANvpjzHw9w)nk@k~}SN`ax~#puYYUh=k#!7$=!MfY+m*$-^Z0rFe_t%McgVbf4#_ zssvACTi_pvcKnDCj`yT4K&QuaJ#CR7Sly%(yaOU7^};ZHYx4+(W=Qa?gy50UDY^iS z%VgOHDQ8h5sRXZyxcavOLep&`}G~etb%BZ_B-ioAS39uH)~BdpS`A@2Im!CTvu@dwB@sEzR>eSx94(>OwBmoTs{&tuPLat)FNA0#<=4$w_)W0y$j zTA*nX2!0Ntb;yK?h?po3w`i{#W3GmqB z8$<;525w40H`JH%XjcS30`G+0M~ElWy9}w;x)c#}RfZjv=&jY$&O?yba>j zIuj{uWQ&=IjQ33>)E+gCLaH%5<7a1^(rqau(O};U+bjciC;Pg8RYU4xcTy9qyAmPS z@c>e@e7#R^$LqLBJXxyGW5Jex2(xtCv3S?KxQ^^>ZMO+2#Q7MKUDQ@TkH_d2XtB6xv%MKa+hoe^>ci;=|O!HAo!4N`FO^Bg1jf%;|c z;$z>nNCNd|4#s%`K1w*768tE<^(I&O{M2O&rXoSB&Pb%~Ql!XGE?_4lL_f&KzAKRM z`gab-c^{TC1XF@v>GAi;B%>CGE6fFMMIyOvka{GGv;3Nh5LM_uu&+wB91&^FjChRc z;zpqoygT06@z;7uEL^GfeFDcG1}QqgL4gk#&*U_EF|@a9M**i0BnUgy0vlkE&7 zD0QRSso93^NMdjk%l#%HW$B_!oEVI_qdnmj=o#W+kIjwP_AWpoX8R#Qnda)z*jeA? znrb_i0&9>^{t`s6zZfZFHiymO{Ta9w4K2|1%Sfa}-^C=LAf*M;+3$U@t6uvi;(~l6 zqH$HziDN(zf*0XkFYw+7-qdPHH-nRqk_jd?zH72MakWK;?KUDQUf=2OQ^b$ECSszj zRu9a5zoh>3oKlID&qve9=&Ds8p0-0yOvPI^?h+|vZe z5UPI-apGrsL(dFhkozG8CGO-_qHrR? zdL&hba$xV`;^OJHGk6oVyE5USfP-s+L<%SAs=Zo59%421gxsp;%uFOq+$Dl@&DLx0 zL3RXwJ>0ZEpv>fSnR`HuiNWO);pXq@=Me!H@Ge=)ZgpW?w}2FpOxstVK!oD-mJV zw}>`n*N~3A3Ah`H*1eSQ`_Kot-*TUK5HC{LC`4Sc#suHZ<8!H-%*UEq@<*pDZ%@B9PBOZbQcBc9T`RC zeR{GPDI|LL65;{63eidj#TZ1R{$hf!{T97;+lg*Q$m7@rsq$q+@S{Br_M9cTA2f02 z;XE_F=n7Pcx|D7 zqa2>mhbz(lhW{?WrHDT0ZzQiqOflkBvR$bD8sZoRdJ+5(j|04F_%KHkZj;koK||mv zq{ZLf0gm$wlG&cLT+!>*3NXbI!tJ4Xa7jr?gUSfr42e`#hS``^sv1t^wM+64^h9cm z49CA~@k=BTWn#h>ozG&I#QY{A+6(LaM^;8~ua)l-)!hlYraxmRlU+wR z!aacAB_$<=TO)W^j~(Ch_ zLA*`>L-1N;77)!hSkPP)z&ntKpg-d4-p}X$*CUmxl462Ag#Nj*f4M(FW$Q7Yu5`29uM81r zy&LoRyW!p6sUjXiGWq?WeVX9SJT~+Sp|*|jhONMD=dUDSJ4C->TPu6LIs<-)dHlCv zp7FFExZ3A=YL}Fh?3BVgX?B*!0@HPl6`l+LU7? zuZ2jLds*(cOc$+jP6`by7o5-GzobTsLZoU@Cd~C1Y%Pa3=S3s{vSp$DawGz_Fasgl zBcbCS`l)P`10)}ZWVqY3N}sM~LY$fVLlEtZiNLB%7s{{sA$SV!>YQ7w$?UJn=7{Kpm9hLDK1pU&VBhh{@SFpNa5XRGZVp^IJ_zM z6K>+|WPQjz^*YW(B*EobNb*;)Z`VBxGlghW7=T@ewi|t%qge{+U{x8`k~uZ1fx{c} zUWCV9gyabJR-#;qUAf@6v6Ftn>sjox3F*lbXX_Q4w8rs1Z1ILEj}@&~g0V~Ox2xKP z^L4h^9TCsJo+TvTTTKs}RKZ`=?28NC@NTeBah)~N^7uQX$Xud$d4e8b7sux-LrP@y zRqxE`EHGbsAQ}`KyiU9c;@4sx{CN>cois)L6q)t9UcFXaw&oZ@eAz-@BXZz9XSM?#6_FHQtNDwC`1Ba`vJ}to{f57sK_dDV` z+!)h%hgodBz^kL(M zh5a!vH?bPY6f!|!!T9mx%RN@EM|&(X*TrZ$tW*!k5;ixVnvYb0nxQjp)MnJqhzs+m z1QLA=c6qWzde2(NG-;TUybXq(m4gyIZJ#Dta5V!7^1Q7#F{-c5u}C1PVZyHeOvD9h zvrwH7(^xy;(NwAeKEOb9mI`4|pC^3L)e2G4J&q(!PgAc!SHew_egSdSjY-(`--YBx zn&Lg+iI~QEuEn-SH5$DLUSxPfvI*(pL=%x>^Y`FCi+xKh(V6@-l2bcy8-2NLCbP?8 zT3ei8@dX^C_dBD#?sd^7LaMjP-cH9&kSe&7^f#1n#AA=C7h^_3uCuG)G z+IX!kmZuQCNoA;Gc%rAt9qfoyWtyq8UXW&4OOcY)FC^f)Y9Wn#P1hakvGY%dgUBQ<0y!_O%XTdSVoiJl{wEjEInA);BHg0vL(i}h+-KAV7R>ZM~b#TdLxhC~6I zNbIN#f18&gv!Kc}P_SGVGP#IWh$iJf*h^B=*o26hl0fp?EWXU;y5Mw;VvEJ*3;a=1 zG6^aEdAS$CYg*W%w*VW+T^xY~7fuR5@{{#Ni4%>nE7JK6-lhA(Mj?i!0E>%@*C1^z zr|QCZuj1n3j>W~rw-px`|5B)n#7x);vqaUox=1@Ohe=*Xzf^xl#9yl|_uqhY7<(K0 z%=j>IKBDQEYPkKi_)8fJf0CxnSk79=VI?sPo9_CU*^1ox^B` z2O_#0+eGYVEf!Nz;6}{l&QJJQSjRexrw~z4CNsrv2e9vvmTv2+5Xn0s_5W;1en||A zxHMWJo*fgcjKTaoJSf5OFemEZKfv)3;yJmRBK?chtqUO{t5YkTS<{pdIFNgs;im5Fu<-!>)VsRtfGk z;0^%?`5~gLn^uKLei-)U7@k71sN%rcmg97NFC!&*=MV<@gOYq)6(ae0z=@Xo48d(V zjx_#)6xlaj7?(L7TR{+le@o_~mYqWy=qe;Ia!O1OF%CRpY2qzFvh`h~065)n+g~wj z?H(4I;4|+xP4Eqf0;@7KAlyvr$C1qF(N%!pHPs%sNuU@-Jh`qXTFjLHc09H|K?n}s zim|YJ@%)U0V!M)kd7ZY{1If5IMLF?^)|z5oFlZcZQx&@hCHO}k+xCoT;GgQT4?udg zZ^}`UpNw}2j*6HV!z>9RBs0N61I~nrZuqDIQE>;aS+qCN_M-m;2{`Pev)9KtNcM-Y zYq>Za_X*woEr?X&a9nlq;jXTDA&bfE4{wB<0zZq8(Dgw|h9eO@@)$(B@q?N-E6BbC zi$>U0f1QemoLr)bg;T+`M*QF)1P2k~XTsr*FK7kQY-t2iZ={pjv%4VCts;FO2O;jY zQJD38i4%XrF4^JE7{+KS0sc-W8&~KNl;Cf8Y+sx(vXmokwU3cXN2ep&iq=S<_iqzQ z^7}B4a(;xr{xm^g^PJywIIe?&5_|%g^~s&oMov0@M6}NPs8`_mgxT}$F)wffb~UlX zz@B*bPff$6KfEz^8D@VV_&N_WrGOAb=#KFj(t5CM4EAg$T#dPY{NH%z&W4Rc4Yzac z;_VoO;NTrfKbGvobbUGdkc^UQjV)&Jjkwo;m=@oek6l}lpy(Ww;Qt}B&Y&CSnuR3d zEu>7_qX`(xWfrrz>x!?vFn1Te?{HlE2POC-;J+UGok(_LHBvWwAel?oxtPUG@8uNS zR+*}+W}T@S=n5Tz5*)mU}ZA?TC4}TXMqU5!eFs^7P*5NYI81$>HH@f zZZ{9NxtpfKt5VFXWQBotK?x30+A9!@JSX5Q~{7TW}vz zF4;8(7;g6iZYxZg5`1d55gbIklfH64!wcuhTFcCzy+Pl z;MuOG_sWali|{VmeksA)e0Yto2O=^367g9t({ZgtN>O|OTu-=C-g&@HjtO1|b1~5e z4##DhsyG{WiO5f5D3vyeRNZOtHk}#)u}?z6>l2U!hz|TQ>Q@)>)n0|v>zIht?hXTY z;$HvJ*Kj+R1?f#In{7Y}ibjpOSi}xY2tFC951k2DhB%A2LgcTHV^|-$0=gpd&9T4^ z0mrcp_ca4e{mwIRSCyc?#l4JLi(jr2--<8^4sf%8UJ(B8I8YRI^X7LNK?+8%?DF9R}!iN(?8v7=0vw=(tzRyV@!J}G~565Su z)V9uqSI@+n*cY5UAOAJTP0E&d<53>;dF#+vk8+67ppRWR3 z3W-cza?2AqrlldD_q?DBS3d-wiFfd)ITBqoA-GEn@VTE$orS4-Z&?Bf9%lcZm+)4! zMnZ6a8w@^2=Ocla%1{mWNfW(%?&mTYqIv=eUenU72#SS-6Iby~@Rf+i#Ov5kW-wKn zV%Nte47BsP-y+<3QcTI@vH-nJY+_9a=Q}N|1#2q6zR%;WYTKR4JLK+)du)ThhDK$$ zYoBK`Te=!kp~beP0nha?AIv*E|)GJCihmmmw0y$z&E=bwLsr&Z_V^ z+Tif>2a;I4(Z_z(h&F>L4!b%ke3GQWq(VB*Y|P3?3}tgCuTtEX1@@Z>vx~zq+L&&x ziZ89n*0(Jc;<29ApBEmeV9vPC5cgX+r-j2Y+9Wc#GMiTB3BGxT{@!3k{vwj=_Z05x zkj%xqgGFW7*WoiU4R^aNowq7a@XhvPe}hk2ec)AHIgfI5tt0X8R_o;OnV1Te>Ny-! zeg?0ADM%#B3oVgkgxd&Tq_ZWy3GgBn0Dp4$Onyor!58NV{=XQFS=oh-z(0w$Le^TO z_v1#N`*%RPqq%}Np%X6pgYj~=34u6FJLwrvQp_MAM+HlFz~U(wk;iwYmOswKY(;b~vsdBR+m15avghAn1Pf= zHo?xgYd#R=?A-tNh!}FUucseQDwlGq}$+IBe|(fULC1SbwAP7Ay1?4ybEy{2(x5H zfv%}u#;kfkItk*LY$JHuT+8fzRw>sgTg{eKZSK;xED`ho6hx6pbs@pe2&z_HubZ1Q9Haig0Yn8Z1GzR_ra!3w@dSBI^hVdx&o8b z$zXyNNGa`-peK%-;OU!q0A>--^h_`w2?~VW0P9PnjmSL5U$XBFx9x~!E9-#xIN<)( z5O?o~h|AXmbCJfpp|oj90>MFoK?hsDu|xHx=o<1^e$X2{-O;t%bdebB__+khk=#?) z71t@zP4Jn1r9-PEmK1`6__h1t-A$q*TI)@`J>=PZK9Y6xdBoQ|$Ks_f0*;Nr8DNV- z;1V?@Z8~*4i?lQkRoImzf~W1^%aP3NH5S)!A>z*J8{$|N1BW2>!K1=Wm?vSBA`*ma z^#zOy8@(1|8^8l&~?|K4Js=K5e>#J&iBWmts- z8lH&Y8W#YMS?)6rks>tHh4xs&>ml?7QcrScL=*Ia#lAZtBB@U?ZyXC!gYXdSYszOm z!9g_K`(u{KToL`$h8syZr5@G;r|9v*p1u7_3^pMl?qiUM>nTVXJ==PPbCIa+-a7l< zjh*hK22!K)M_nJ-6e5nAhIBrwXR+@FM5TEs4iYJn zPVh9I2KK>DZ3iOexd#z44GDqh4=Is?whtLbG}Qza=@<{$g6ySgz8$AC{%MGN(ssr# zKr|uWAORTLavD?A^t=T})o}~Pj~`DKAqAX^)F=1jHJOL>dl`jy(a=n&t)JI+`rAkU zYf`7=6T}T!?(n`9;y))fz5j7K+xzLKv57YsbBf><7nBdbMas9dJ=Gk{x@`Z5xkJ>#4I%xjzik1*h*XL ztC?^aqK|k$7dt^`)j9fmxx&8{=_0PZ{(m-*yQ3}|2jM@yuo8)4-jCZhj5$H@G@e)6 za+t2>tNXbAWAryu7i&)uZVqCpk~-l)!4~@xn}vAnsruC$ja#o!l_q!^6Dkn>GQ!D%X`~CU zLHhrT5$(li>Lr+rL{ zfao?3ukdfHkO<#&q*B!^CH*h@3(~=%781Z|qBC=IT|4ZqYmglyypQFG^6_>;(rV`k z9xf*9;^$IbSPe$})?uTLF0?vV^7r47%3aI#Wmu=biUE-7NLpGE5>%?E3&L$;xNnP* zJk(#<+=PY^90X~bx50)*D82TdLWti2Ov?u8VMf% zCM1<_B9goM0d7hm=Lw#rSd65JjjiDAXovWo+v^O!2mY0JL9h^UO-=#6MWTz}5J8?} zp5Rpn8;}6cmQv7dkYs>nO7>lmAWUP#-M0gx9j`^^N?I!sx8h2~wYXGGs9%xFy7Lg% i-AuB$6Izt`{{a9CH0GJi2@$^l0000 v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'ReadtheDocsTemplatedoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'ReadtheDocsTemplate.tex', u'Read the Docs Template Documentation', + u'Read the Docs', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'readthedocstemplate', u'Read the Docs Template Documentation', + [u'Read the Docs'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'ReadtheDocsTemplate', u'Read the Docs Template Documentation', + u'Read the Docs', 'ReadtheDocsTemplate', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000000..f74a3acae1 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,88 @@ +.. Read the Docs Template documentation master file + +Welcome to ESP32 Programming Guide +================================== + + +Example C functions +------------------- + +.. c:function:: esp_err_t esp_wifi_get_ap_list (uint16_t *number, wifi_ap_list_t *ap_list) + +.. c:function:: esp_err_t esp_wifi_set_protocol (wifi_interface_t ifx, uint8_t protocol_bitmap) + + +Example C function integration +------------------------------ + +.. doxygenfunction:: esp_wifi_init +.. doxygenfunction:: esp_wifi_set_config + +.. doxygenfunction:: gpio_isr_register +.. doxygenfunction:: ledc_timer_set + + +Example C enum integration +-------------------------- + +.. doxygenenum:: wifi_auth_mode_t + + +Example C struct integration +---------------------------- + +.. doxygenstruct:: wifi_scan_config_t + :members: + + +Contents: + +.. About - TBA + +.. toctree:: + :caption: Toolchain Setup + :maxdepth: 1 + + windows-setup + linux-setup + macos-setup + eclipse-setup + +.. API Reference - TBA + +.. Technical Reference - TBA + +.. toctree:: + :caption: Debugging + :maxdepth: 1 + + openocd + +.. Resources - TBA + +.. toctree:: + :caption: Contribute + :maxdepth: 1 + + contributing + contributor-agreement + +.. toctree:: + :caption: Copyrights and Licenses + :maxdepth: 1 + + COPYRIGHT + +.. toctree:: + :caption: Flapping Documents + :maxdepth: 1 + + partition-tables + build_system + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000000..188f51e62d --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +breathe \ No newline at end of file