[pypy-commit] pypy improve-docs: Fix some references.
mjacob
noreply at buildbot.pypy.org
Fri Oct 24 12:44:07 CEST 2014
Author: Manuel Jacob <me at manueljacob.de>
Branch: improve-docs
Changeset: r74157:322db947aaeb
Date: 2014-10-24 12:46 +0200
http://bitbucket.org/pypy/pypy/changeset/322db947aaeb/
Log: Fix some references.
diff --git a/pypy/doc/coding-guide.rst b/pypy/doc/coding-guide.rst
--- a/pypy/doc/coding-guide.rst
+++ b/pypy/doc/coding-guide.rst
@@ -384,10 +384,8 @@
Only specified names will be exported to a Mixed Module's applevel
namespace.
-Sometimes it is necessary to really write some functions in C (or
-whatever target language). See :doc:`rffi <rpython:rffi>` and :ref:`external functions
-documentation <rpython:extfunccalls>` for details. The latter approach is cumbersome and
-being phased out and former has currently quite a few rough edges.
+Sometimes it is necessary to really write some functions in C (or whatever
+target language). See :ref:`rffi <rpython:rffi>` details.
application level definitions
diff --git a/pypy/doc/dev_method.rst b/pypy/doc/dev_method.rst
--- a/pypy/doc/dev_method.rst
+++ b/pypy/doc/dev_method.rst
@@ -191,7 +191,7 @@
expectations is also good to do. Unfortunately there is always time spent
the first day, mostly in the morning when people arrive to get the internet
and server infrastructure up and running. That is why we are, through
- :doc:`documentation <getting-started-index>`, trying to get participants to
+ :ref:`documentation <getting-started-index>`, trying to get participants to
set up the tools and configurations needed before they arrive to the sprint.
Approximate hours being held are 10-17, but people tend to stay longer to
diff --git a/pypy/doc/eventhistory.rst b/pypy/doc/eventhistory.rst
--- a/pypy/doc/eventhistory.rst
+++ b/pypy/doc/eventhistory.rst
@@ -173,7 +173,7 @@
with its features preserved.
See the :doc:`release 0.8 announcement <release-0.8.0>` for further details about the release and
-the :doc:`getting started <getting-started-index>` document for instructions about downloading it and
+the :ref:`getting started <getting-started-index>` section for instructions about downloading it and
trying it out. There is also a short :doc:`FAQ <faq>`. *(11/03/2005)*
@@ -207,7 +207,7 @@
implementation of Python in C :-)
See the :doc:`release announcement <release-0.7.0>` for further details about the release and
-the :doc:`getting started <getting-started>` document for instructions about downloading it and
+the :ref:`getting started <getting-started-index>` section for instructions about downloading it and
trying it out. We also have the beginning of a :doc:`FAQ <faq>`. *(08/28/2005)*
diff --git a/pypy/doc/faq.rst b/pypy/doc/faq.rst
--- a/pypy/doc/faq.rst
+++ b/pypy/doc/faq.rst
@@ -101,7 +101,7 @@
another (e.g. older) PyPy. Cross-translation is not really supported:
e.g. to build a 32-bit PyPy, you need to have a 32-bit environment.
Cross-translation is only explicitly supported between a 32-bit Intel
-Linux and ARM Linux (see :doc:`here <arm>`).
+Linux and ARM Linux (see :ref:`here <rpython:arm>`).
Which Python version (2.x?) does PyPy implement?
@@ -159,7 +159,7 @@
For pure Python algorithmic code, it is very fast. For more typical
Python programs we generally are 3 times the speed of CPython 2.7.
You might be interested in our `benchmarking site`_ and our
-:doc:`jit documentation <rpython:jit/index>`.
+:ref:`jit documentation <rpython:jit>`.
`Your tests are not a benchmark`_: tests tend to be slow under PyPy
because they run exactly once; if they are good tests, they exercise
diff --git a/pypy/doc/introduction.rst b/pypy/doc/introduction.rst
--- a/pypy/doc/introduction.rst
+++ b/pypy/doc/introduction.rst
@@ -2,7 +2,7 @@
=============
In common parlance, PyPy has been used to mean two things. The first is the
-:ref:`RPython translation toolchain <rpython:rpython>`, which is a framework for generating
+:ref:`RPython translation toolchain <rpython:index>`, which is a framework for generating
dynamic programming language implementations. And the second is one
particular implementation that is so generated --
an implementation of the Python_ programming language written in
@@ -11,7 +11,7 @@
This double usage has proven to be confusing, and we are trying to move
away from using the word PyPy to mean both things. From now on we will
try to use PyPy to only mean the Python implementation, and say the
-:ref:`RPython translation toolchain <rpython:rpython>` when we mean the framework.
+:ref:`RPython translation toolchain <rpython:index>` when we mean the framework.
Some older documents, presentations, papers and videos will still have the old
usage. You are hereby warned.
diff --git a/pypy/doc/you-want-to-help.rst b/pypy/doc/you-want-to-help.rst
--- a/pypy/doc/you-want-to-help.rst
+++ b/pypy/doc/you-want-to-help.rst
@@ -29,7 +29,7 @@
PyPy has layers. The 100 miles view:
-* :doc:`RPython <rpython:rpython>` is the language in which we write interpreters. Not the entire
+* :ref:`RPython <rpython:language>` is the language in which we write interpreters. Not the entire
PyPy project is written in RPython, only the parts that are compiled in
the translation process. The interesting point is that RPython has no parser,
it's compiled from the live python objects, which makes it possible to do
@@ -55,7 +55,7 @@
directory. The standard library of Python (with a few changes to
accomodate PyPy) is in ``lib-python``.
-* :doc:`Just-in-Time Compiler (JIT) <rpython:jit/index>`: we have a tracing JIT that traces the
+* :ref:`Just-in-Time Compiler (JIT) <rpython:jit>`: we have a tracing JIT that traces the
interpreter written in RPython, rather than the user program that it
interprets. As a result it applies to any interpreter, i.e. any
language. But getting it to work correctly is not trivial: it
@@ -69,7 +69,7 @@
* Garbage Collectors (GC): as you may notice if you are used to CPython's
C code, there are no ``Py_INCREF/Py_DECREF`` equivalents in RPython code.
- :doc:`rpython:garbage-collection` is inserted
+ :ref:`rpython:garbage-collection` is inserted
during translation. Moreover, this is not reference counting; it is a real
GC written as more RPython code. The best one we have so far is in
``rpython/memory/gc/incminimark.py``.
diff --git a/rpython/doc/arm.rst b/rpython/doc/arm.rst
--- a/rpython/doc/arm.rst
+++ b/rpython/doc/arm.rst
@@ -1,3 +1,5 @@
+.. arm:
+
Cross-translating for ARM
=========================
diff --git a/rpython/doc/garbage_collection.rst b/rpython/doc/garbage_collection.rst
--- a/rpython/doc/garbage_collection.rst
+++ b/rpython/doc/garbage_collection.rst
@@ -1,6 +1,8 @@
.. TODO cleanup after merge of gc-del
+.. garbage-collection:
+
=============================
Garbage Collection in RPython
=============================
diff --git a/rpython/doc/index.rst b/rpython/doc/index.rst
--- a/rpython/doc/index.rst
+++ b/rpython/doc/index.rst
@@ -1,3 +1,5 @@
+.. index:
+
Welcome to RPython's documentation!
===================================
diff --git a/rpython/doc/jit/index.rst b/rpython/doc/jit/index.rst
--- a/rpython/doc/jit/index.rst
+++ b/rpython/doc/jit/index.rst
@@ -1,3 +1,5 @@
+.. jit:
+
JIT documentation
=================
diff --git a/rpython/doc/rpython.rst b/rpython/doc/rpython.rst
--- a/rpython/doc/rpython.rst
+++ b/rpython/doc/rpython.rst
@@ -1,3 +1,5 @@
+.. language:
+
RPython Language
================
More information about the pypy-commit
mailing list