docs: Modify Makefile and indexes to generate cPy-differences pages.

crypto-aes
Rami Ali 6 years ago committed by Damien George
parent b7fa63c7ce
commit 3218ccd70d
  1. 4
      .gitignore
  2. 18
      docs/Makefile
  3. 1
      docs/esp8266_contents.rst
  4. 1
      docs/esp8266_index.rst
  5. 1
      docs/pyboard_contents.rst
  6. 1
      docs/pyboard_index.rst
  7. 4
      docs/topindex.html
  8. 1
      docs/unix_contents.rst
  9. 1
      docs/unix_index.rst
  10. 1
      docs/wipy_contents.rst
  11. 1
      docs/wipy_index.rst

4
.gitignore vendored

@ -38,3 +38,7 @@ __pycache__/
######################
GNUmakefile
user.props
# Generated rst files
######################
genrst/

@ -6,6 +6,9 @@ SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build/$(MICROPY_PORT)
CPYDIFFDIR = ../tools
CPYDIFF = gen-cpydiff.py
GENRSTDIR = genrst
# Run "make FORCE= ..." to avoid rebuilding from scratch (and risk
# producing incorrect docs).
FORCE = -E
@ -48,11 +51,18 @@ help:
@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)"
@echo " cpydiff to generate the MicroPython differences from CPython"
clean:
rm -rf $(BUILDDIR)/*
rm -f $(GENRSTDIR)/*
html:
cpydiff:
@echo "Generating MicroPython Differences."
rm -f $(GENRSTDIR)/*
cd $(CPYDIFFDIR) && python $(CPYDIFF)
html: cpydiff
$(SPHINXBUILD) $(FORCE) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@ -106,20 +116,20 @@ epub:
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
latex: cpydiff
$(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:
latexpdf: cpydiff
$(SPHINXBUILD) $(FORCE) -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:
latexpdfja: cpydiff
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja

@ -8,4 +8,5 @@ MicroPython documentation contents
esp8266/tutorial/index.rst
library/index.rst
reference/index.rst
genrst/index.rst
license.rst

@ -5,6 +5,7 @@ MicroPython documentation and references
esp8266/quickref.rst
library/index.rst
genrst/index.rst
license.rst
esp8266_contents.rst

@ -9,5 +9,6 @@ MicroPython documentation contents
library/index.rst
reference/index.rst
pyboard/hardware/index.rst
genrst/index.rst
license.rst

@ -8,6 +8,7 @@ MicroPython documentation and references
pyboard/tutorial/index.rst
library/index.rst
pyboard/hardware/index.rst
genrst/index.rst
license.rst
pyboard_contents.rst

@ -47,6 +47,10 @@
<span class="linkdescr">MicroPython libraries, including the <a href="{{ pathto("library/machine") }}">machine module</a></span>
{% endif %}
</p>
<p class="biglink">
<a class="biglink" href="{{ pathto("genrst/index") }}">Micropython Differences</a><br/>
<span class="linkdescr">MicroPython operations which differ from CPython</span>
</p>
</td>
<td width="40%" style="padding-left:2em;">
<p class="biglink">

@ -5,4 +5,5 @@ MicroPython documentation contents
library/index.rst
reference/index.rst
genrst/index.rst
license.rst

@ -4,6 +4,7 @@ MicroPython documentation and references
.. toctree::
library/index.rst
genrst/index.rst
license.rst
unix_contents.rst

@ -8,4 +8,5 @@ MicroPython documentation contents
wipy/tutorial/index.rst
library/index.rst
reference/index.rst
genrst/index.rst
license.rst

@ -7,6 +7,7 @@ MicroPython documentation and references
wipy/general.rst
wipy/tutorial/index.rst
library/index.rst
genrst/index.rst
license.rst
wipy_contents.rst

Loading…
Cancel
Save