Read about our upcoming Code of Conduct on this issue

Commit 285c2d9e authored by Pierre Augier's avatar Pierre Augier
Browse files

Doc Cython

parent 245c682d001a
......@@ -37,7 +37,7 @@ speedup)!
.. warning ::
Transonic is still in a early stage (see our `roadmap
<https://transonic.readthedocs.io/en/latest/roadmap.html>`_.). Remarks and
<https://transonic.readthedocs.io/en/latest/roadmap.html>`_). Remarks and
suggestions are very welcome.
In particular, Transonic is now only able to use the Pythran and Cython
......@@ -127,7 +127,7 @@ The default Transonic backend uses Pythran and works well. `Here, we explain
why Pythran is so great for Python users and why Transonic is great for Pythran
users <https://transonic.readthedocs.io/en/latest/pythran_backend.html>`_
Another backend using Cython starts to work.
There is also an alpha version of the Cython backend.
.. note ::
......@@ -162,7 +162,7 @@ Transonic is sensible to environment variables:
compilation of jited functions. This can be useful for unittests.
- :code:`TRANSONIC_BACKEND` to choose between the supported backends, i.e. now
only "pythran" and "cython"! The "numba" backend should soon work!
only "pythran" and "cython". The Numba backend should soon be available!
A short tour of Transonic syntaxes
......@@ -194,15 +194,15 @@ Most of this code looks familiar to Pythran users. The differences:
- :code:`# transonic def` instead of :code:`# pythran export`.
- A tiny bit of Python... The decorator :code:`@boost` replaces the
Python function by the pythranized function if Transonic has been used to
produced the associated Pythran file.
Python function by the compiled function if Transonic has been used to
produced the associated Pythran/Cython/Numba file.
Pythran using type annotations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The previous example can be rewritten without :code:`# transonic def`. It is
the recommended syntaxes for ahead-of-time function acceleration:
the recommended syntaxes for ahead-of-time compilation:
.. code :: python
......@@ -351,8 +351,8 @@ given `here
<https://transonic.readthedocs.io/en/latest/examples/methods.html>`__.
Make the Pythran files
----------------------
Make the Pythran/Cython/Numba files
-----------------------------------
There is a command-line tool :code:`transonic` which makes the associated
Pythran files from Python files with annotations and transonic code. By
......
Cython backend (v0)
-------------------
Cython backend (alpha version)
------------------------------
- Analyses: variable type annotations in functions and methods
- Cython types for arrays (memory views, i.e. as ``np.float64_t[:]``)
- Cython "locals" types
- Doc Cython
Cython backend (v1)
-------------------
Cython backend (beta version)
-----------------------------
Less bugs and more Cython features...
- Less bugs
- Fused types rather than more than one signature
- "exterior" functions + understand the tests
- Recompile if pxd changed
- Recompile if pxd changed + signature file for Pythran (``.pythran``) and
Cython (``.pxd``)
setup.py & more than one backend at runtime
-------------------------------------------
......@@ -49,3 +52,8 @@ Alternative syntax for blocks
-----------------------------
See `issue #6 <https://bitbucket.org/fluiddyn/transonic/issues/6>`_
Alternative implementations for specified backends
--------------------------------------------------
Which API?
......@@ -25,8 +25,9 @@
import transonic
from fluiddoc.ipynb_maker import ipynb_to_rst
# ipynb_to_rst()
ipynb_to_rst('ipynb/executed', executed=True)
ipynb_to_rst("ipynb/executed", executed=True)
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
......@@ -37,36 +38,40 @@ ipynb_to_rst('ipynb/executed', executed=True)
# -- General configuration ----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.doctest',
'sphinx.ext.todo',
"sphinx.ext.autodoc",
"sphinx.ext.doctest",
"sphinx.ext.todo",
# 'sphinx.ext.pngmath',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode', 'sphinx.ext.autosummary',
'numpydoc',
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"sphinx.ext.autosummary",
"numpydoc",
# 'mathmacro',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]
# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = [".rst", ".md"]
source_parsers = {".md": "recommonmark.parser.CommonMarkParser"}
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
master_doc = "index"
# General information about the project.
project = u'Transonic'
copyright = u'2018, Pierre Augier'
project = u"Transonic"
copyright = u"2018, Pierre Augier"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
......@@ -76,77 +81,77 @@ copyright = u'2018, Pierre Augier'
# The full version, including alpha/beta/rc tags.
release = transonic.__version__
# The short X.Y version.
version = release.split('.')
version = '{}.{}.{}'.format(version[0], version[1], version[2])
version = release.split(".")
version = "{}.{}.{}".format(version[0], version[1], version[2])
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', '**.ipynb_checkpoints']
exclude_patterns = ["_build", "**.ipynb_checkpoints"]
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# modindex_common_prefix = []
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#html_theme = 'default'
html_theme = 'sphinx_rtd_theme'
# html_theme = 'default'
html_theme = "sphinx_rtd_theme"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
html_short_title = 'Transonic ' + release
html_short_title = "Transonic " + release
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# 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
# 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,
......@@ -155,44 +160,44 @@ html_static_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'
# 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
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# html_file_suffix = None
# Output file base name for HTML help builder.
# htmlhelp_basename = 'fluidfftdoc'
......@@ -201,42 +206,45 @@ html_static_path = []
# -- 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': '',
# 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]).
latex_documents = [
('index', 'transonic.tex', u'Transonic Documentation',
u'Pierre Augier', 'manual'),
(
"index",
"transonic.tex",
u"Transonic Documentation",
u"Pierre Augier",
"manual",
)
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
......@@ -244,12 +252,11 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'Transonic', u'Transonic Documentation',
[u'Pierre Augier'], 1)
("index", "Transonic", u"Transonic Documentation", [u"Pierre Augier"], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
......@@ -258,20 +265,25 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Transonic', u'Transonic Documentation',
u'Pierre Augier', 'Transonic', 'One line description of project.',
'Miscellaneous'),
(
"index",
"Transonic",
u"Transonic Documentation",
u"Pierre Augier",
"Transonic",
"One line description of project.",
"Miscellaneous",
)
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# texinfo_show_urls = 'footnote'
# -- Other options ---------------------------------------------------------
......@@ -280,6 +292,6 @@ numpydoc_show_class_members = False
autosummary_generate = True
autodoc_default_options = {"show-inheritance": None}
autodoc_member_order = 'bysource'
autodoc_member_order = "bysource"
todo_include_todos = True
# About Cython with Transonic
# Cython backend
Cython code is much more complicated than Pythran code... We won't be able to
support all Cython!
......
......@@ -9,6 +9,7 @@ Backends
:maxdepth: 2
pythran_backend
cython_backend
other_backends
Examples
......
......@@ -39,6 +39,7 @@ doc =
ipython
jupyter
fluiddyn
recommonmark
dev =
%(doc)s
......
......@@ -178,10 +178,11 @@ def gather_rawcode_comments(node, code_module):
# TODO complete the list
packages_supported_by_pythran = ["numpy", "math", "functools", "cmath", "scipy"]
# FIXME find path in non local imports
def find_path(node: object, pathfile: str):
""" Return the path of node (instance of ast.Import or ast.ImportFrom)
"""
# FIXME find path in non local imports
name = str()
path = str()
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment