Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
TASTE
uPython-mirror
Commits
3218ccd7
Commit
3218ccd7
authored
Feb 07, 2017
by
Rami Ali
Committed by
Damien George
Feb 20, 2017
Browse files
docs: Modify Makefile and indexes to generate cPy-differences pages.
parent
b7fa63c7
Changes
11
Hide whitespace changes
Inline
Side-by-side
.gitignore
View file @
3218ccd7
...
...
@@ -38,3 +38,7 @@ __pycache__/
######################
GNUmakefile
user.props
# Generated rst files
######################
genrst/
docs/Makefile
View file @
3218ccd7
...
...
@@ -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
...
...
docs/esp8266_contents.rst
View file @
3218ccd7
...
...
@@ -8,4 +8,5 @@ MicroPython documentation contents
esp8266/tutorial/index.rst
library/index.rst
reference/index.rst
genrst/index.rst
license.rst
docs/esp8266_index.rst
View file @
3218ccd7
...
...
@@ -5,6 +5,7 @@ MicroPython documentation and references
esp8266/quickref.rst
library/index.rst
genrst/index.rst
license.rst
esp8266_contents.rst
...
...
docs/pyboard_contents.rst
View file @
3218ccd7
...
...
@@ -9,5 +9,6 @@ MicroPython documentation contents
library/index.rst
reference/index.rst
pyboard/hardware/index.rst
genrst/index.rst
license.rst
docs/pyboard_index.rst
View file @
3218ccd7
...
...
@@ -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
...
...
docs/topindex.html
View file @
3218ccd7
...
...
@@ -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"
>
...
...
docs/unix_contents.rst
View file @
3218ccd7
...
...
@@ -5,4 +5,5 @@ MicroPython documentation contents
library/index.rst
reference/index.rst
genrst/index.rst
license.rst
docs/unix_index.rst
View file @
3218ccd7
...
...
@@ -4,6 +4,7 @@ MicroPython documentation and references
.. toctree::
library/index.rst
genrst/index.rst
license.rst
unix_contents.rst
...
...
docs/wipy_contents.rst
View file @
3218ccd7
...
...
@@ -8,4 +8,5 @@ MicroPython documentation contents
wipy/tutorial/index.rst
library/index.rst
reference/index.rst
genrst/index.rst
license.rst
docs/wipy_index.rst
View file @
3218ccd7
...
...
@@ -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
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment