Author: Matti Picus <[email protected]> Branch: Changeset: r94515:7e57ef5dd229 Date: 2018-05-09 20:24 +0300 http://bitbucket.org/pypy/pypy/changeset/7e57ef5dd229/
Log: rearrange indexing, deprecate older documents diff --git a/pypy/doc/conf.py b/pypy/doc/conf.py --- a/pypy/doc/conf.py +++ b/pypy/doc/conf.py @@ -66,9 +66,9 @@ # built documents. # # The short X.Y version. -version = '5.8' +version = '6.0' # The full version, including alpha/beta/rc tags. -release = '5.8.0' +release = '6.0.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/pypy/doc/contributing.rst b/pypy/doc/contributing.rst --- a/pypy/doc/contributing.rst +++ b/pypy/doc/contributing.rst @@ -32,7 +32,7 @@ works in the real world then this is a great project! Getting involved ----------------- +^^^^^^^^^^^^^^^^ PyPy employs a relatively standard open-source development process. You are encouraged as a first step to join our `pypy-dev mailing list`_ and IRC channel, @@ -51,7 +51,7 @@ Your first contribution ------------------------ +^^^^^^^^^^^^^^^^^^^^^^^ The first and most important rule how **not** to contribute to PyPy is "just hacking a feature". This won't work, and you'll find your PR will typically @@ -74,7 +74,7 @@ .. _issue tracker: https://bitbucket.org/pypy/pypy/issues Source Control -============== +-------------- PyPy development is based a typical fork/pull request based workflow, centered around Mercurial (hg), hosted on Bitbucket. If you have not used this workflow @@ -176,7 +176,7 @@ Architecture -============ +^^^^^^^^^^^^ PyPy has layers. Just like ogres or onions. Those layers help us keep the respective parts separated enough to be worked on independently and make the @@ -224,7 +224,7 @@ as a first approximation. (Some types have multiple implementations.) Building -======== +^^^^^^^^ For building PyPy, we recommend installing a pre-built PyPy first (see :doc:`install`). It is possible to build PyPy with CPython, but it will take a @@ -234,7 +234,7 @@ Further Reading: :doc:`Build <build>` Coding Guide -============ +------------ As well as the usual pep8 and formatting standards, there are a number of naming conventions and coding styles that are important to understand before @@ -243,7 +243,7 @@ Further Reading: :doc:`Coding Guide <coding-guide>` Testing -======= +^^^^^^^ Test driven development ----------------------- @@ -326,7 +326,7 @@ .. _`build requirements`: build.html#install-build-time-dependencies Tooling & Utilities -=================== +^^^^^^^^^^^^^^^^^^^ If you are interested in the inner workings of the PyPy Python interpreter, there are some features of the untranslated Python interpreter that allow you @@ -433,7 +433,7 @@ Demos ------ +^^^^^ The `example-interpreter`_ repository contains an example interpreter written using the RPython translation toolchain. @@ -442,7 +442,7 @@ graphviz & pygame for flow graph viewing (highly recommended) -------------------------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ graphviz and pygame are both necessary if you want to look at generated flow graphs: diff --git a/pypy/doc/embedding.rst b/pypy/doc/embedding.rst --- a/pypy/doc/embedding.rst +++ b/pypy/doc/embedding.rst @@ -1,5 +1,5 @@ -Embedding PyPy -============== +Embedding PyPy (DEPRECATED) +=========================== PyPy has a very minimal and a very strange embedding interface, based on the usage of `cffi`_ and the philosophy that Python is a better language than diff --git a/pypy/doc/index.rst b/pypy/doc/index.rst --- a/pypy/doc/index.rst +++ b/pypy/doc/index.rst @@ -31,6 +31,7 @@ introduction install build + windows faq @@ -44,18 +45,12 @@ cpython_differences extending - embedding gc_info jit-hooks stackless __pypy__-module - objspace-proxies sandbox stm - windows - - -.. _developing-pypy: Development ----------- @@ -77,12 +72,10 @@ .. toctree:: :maxdepth: 1 - extradoc - eventhistory - discussions index-of-release-notes index-of-whatsnew contributor + glossary .. _contact: diff --git a/pypy/doc/objspace-proxies.rst b/pypy/doc/objspace-proxies.rst --- a/pypy/doc/objspace-proxies.rst +++ b/pypy/doc/objspace-proxies.rst @@ -1,28 +1,7 @@ -What PyPy can do for your objects -================================= - -.. contents:: - - -Thanks to the :doc:`Object Space <objspace>` architecture, any feature that is -based on proxying, extending, changing or otherwise controlling the -behavior of objects in a running program is easy to implement on top of PyPy. - -Here is what we have implemented so far, in historical order: - -* *Dump Object Space*: dumps all operations performed on all the objects - into a large log file. For debugging your applications. - -* *Transparent Proxies Extension*: adds new proxy objects to - the Standard Object Space that enable applications to - control operations on application and builtin objects, - e.g lists, dictionaries, tracebacks. - - .. _tproxy: -Transparent Proxies -------------------- +Transparent Proxies (DEPRECATED) +-------------------------------- .. warning:: diff --git a/pypy/doc/project-documentation.rst b/pypy/doc/project-documentation.rst --- a/pypy/doc/project-documentation.rst +++ b/pypy/doc/project-documentation.rst @@ -32,10 +32,13 @@ coding-guide sprint-reports extradoc + eventhistory video-index index-report + discussions dev_method - glossary + embedding + objspace-proxies Source Code Documentation _______________________________________________ pypy-commit mailing list [email protected] https://mail.python.org/mailman/listinfo/pypy-commit
