diff options
| author | gabrieldemarmiesse <gabriel.demarmiesse@teraki.com> | 2018-07-08 10:40:17 +0200 |
|---|---|---|
| committer | gabrieldemarmiesse <gabriel.demarmiesse@teraki.com> | 2018-07-08 10:40:17 +0200 |
| commit | 1b00a53bafcc726e1b07ba8f6b070f69ef6ae4a4 (patch) | |
| tree | 4380a0f0e33529bc0c9387c9b2b9ee12da815790 | |
| parent | b2b507268fa4ffc957ae1137c38f12e3c6fc3e72 (diff) | |
| download | cython-1b00a53bafcc726e1b07ba8f6b070f69ef6ae4a4.tar.gz | |
Docs: Undo PR #2439 because readthedocs does not behave as expected (the html page isn't produced).
| -rw-r--r-- | docs/conf.py | 39 | ||||
| -rw-r--r-- | docs/src/reference/language_basics.rst | 176 |
2 files changed, 176 insertions, 39 deletions
diff --git a/docs/conf.py b/docs/conf.py index b37d38d9d..10662e28c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -455,42 +455,3 @@ pdf_use_numbered_links = False # Background images fitting mode pdf_fit_background_mode = 'scale' - - -# Making redirection: - -html_template = """\ -<html> - <head> - <script> - // Redirect to the new-style URL, but keep any #anchor etc. - window.location.href = '{0}'; - </script> - <meta http-equiv="refresh" content="1; url={0}" /> - </head> -</html> -""" - -list_redirects = [ - ('reference/language_basics', 'userguide/language_basics'), -] - - -def add_legacy_redirects(app, docname): - if app.builder.name != 'html': - return - for old_link, new_link in list_redirects: - old_link = "src/" + old_link + ".html" - new_link = "src/" + new_link + ".html" - - rel_path = os.path.relpath(new_link, os.path.dirname(old_link)) - - html_to_write = html_template.format(rel_path) - target_path = app.outdir + '/' + old_link - - with open(target_path, "w+") as f: - f.write(html_to_write) - - -def setup(app): - app.connect('build-finished', add_legacy_redirects) diff --git a/docs/src/reference/language_basics.rst b/docs/src/reference/language_basics.rst new file mode 100644 index 000000000..bd8b1e38c --- /dev/null +++ b/docs/src/reference/language_basics.rst @@ -0,0 +1,176 @@ +.. highlight:: cython + + +*************** +Language Basics +*************** + +.. note:: + + The sections in this page were moved to the :ref:`language-basics` in the userguide. + +================= +Cython File Types +================= + +This section was moved to :ref:`cython_file_types`. + +Implementation File +=================== + +What can it contain? +-------------------- + +What can't it contain? +---------------------- + +Definition File +=============== + +What can it contain? +-------------------- + +What can't it contain? +---------------------- + +What else? +---------- + +cimport +``````` + +compilation order +````````````````` + +Include File +============ + +What can it contain? +-------------------- + +How do I use it? +---------------- + +==================== +Declaring Data Types +==================== + +This section was moved to :ref:`declaring_data_types`. + +The cdef Statement +================== + +This section was moved to :ref:`c_variable_and_type_definitions`. + +Grouping cdef Declarations +========================== + +This section was moved to :ref:`c_variable_and_type_definitions`. + +C types and Python classes +========================== + +This section was moved to :ref:`types`. + +Parameters +========== + +This section was moved to :ref:`python_functions_vs_c_functions`. + +Automatic Type Conversion +========================= + +This section was moved to :ref:`type-conversion`. + +Type Casting +============ + +This section was moved to :ref:`type_casting`. + +Checked Type Casts +------------------ + +This section was moved to :ref:`checked_type_casts`. + +========================== +Statements and Expressions +========================== + +This section was moved to :ref:`statements_and_expressions`. + +Differences Between Cython and C +================================ + +Scope Rules +=========== + +Built-in Constants +================== + +Operator Precedence +=================== + +For-loops +========== + +===================== +Functions and Methods +===================== + +This section was moved to :ref:`python_functions_vs_c_functions`. + + +Callable from Python (def) +========================== + +Callable from C (cdef) +====================== + +Callable from both Python and C (cpdef) +======================================= + +Overriding +========== + +This section was moved to :ref:`overriding_in_extension_types`. + +Function Pointers +================= + +Python Built-ins +================ + +This section was moved to :ref:`built_in_functions`. + +Optional Arguments +================== + +This section was moved to :ref:`optional_arguments`. + +Keyword-only Arguments +======================= + +This section was moved to :ref:`keyword_only_argument`. + +============================ +Error and Exception Handling +============================ + +This section was moved to :ref:`error_return_values`. + +Checking return values for non-Cython functions.. +================================================= + +This section was moved to :ref:`checking_return_values_of_non_cython_functions`. + +======================= +Conditional Compilation +======================= + +This section was moved to :ref:`conditional_compilation`. + +Compile-Time Definitions +========================= + +Conditional Statements +======================= |