[pypy-commit] pypy improve-docs: Use Sphinx' cross-referencing features in glossaries (this will be expanded).
Manuel Jacob
noreply at buildbot.pypy.org
Thu May 9 05:17:28 CEST 2013
Author: Manuel Jacob
Branch: improve-docs
Changeset: r63934:b9177bbb48cd
Date: 2013-05-08 15:28 +0200
http://bitbucket.org/pypy/pypy/changeset/b9177bbb48cd/
Log: Use Sphinx' cross-referencing features in glossaries (this will be
expanded).
diff --git a/pypy/doc/architecture.rst b/pypy/doc/architecture.rst
--- a/pypy/doc/architecture.rst
+++ b/pypy/doc/architecture.rst
@@ -171,8 +171,8 @@
.. _`document about the RPython toolchain`: translation.html
.. _`garbage collector`: garbage_collection.html
.. _`RPython toolchain`: translation.html
-.. _`standard interpreter`:
-.. _`python interpreter`:
+
+.. _python-interpreter:
PyPy Python Interpreter
-----------------------
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
@@ -44,8 +44,8 @@
but let's stick with this somewhat canonical approach.
-.. _`application-level`:
-.. _`interpreter-level`:
+.. _application-level:
+.. _interpreter-level:
Application-level and interpreter-level execution and objects
-------------------------------------------------------------
diff --git a/pypy/doc/glossary.rst b/pypy/doc/glossary.rst
--- a/pypy/doc/glossary.rst
+++ b/pypy/doc/glossary.rst
@@ -8,7 +8,7 @@
.. glossary::
application level
- applevel_ code is normal Python code running on top of the PyPy or
+ :ref:`applevel<application-level>` code is normal Python code running on top of the PyPy or
:term:`CPython` interpreter (see :term:`interpreter level`)
CPython
@@ -27,7 +27,7 @@
:term:`application level` and :term:`interpreter level` code.
object space
- The `object space <objspace.html>`__ (often abbreviated to
+ :doc:`objspace` (often abbreviated to
"objspace") creates all objects and knows how to perform operations
on the objects. You may think of an object space as being a library
offering a fixed API, a set of operations, with implementations
@@ -41,9 +41,7 @@
Christian Tismer's `Stackless Python <http://www.stackless.com>`__.
standard interpreter
- It is the `subsystem implementing the Python language`_, composed
+ It is the :ref:`subsystem implementing the Python language <python-interpreter>`, composed
of the bytecode interpreter and of the standard objectspace.
-.. _applevel: coding-guide.html#application-level
.. _PSF: http://www.python.org/psf/
-.. _`subsystem implementing the Python language`: architecture.html#standard-interpreter
diff --git a/pypy/doc/objspace.rst b/pypy/doc/objspace.rst
--- a/pypy/doc/objspace.rst
+++ b/pypy/doc/objspace.rst
@@ -1,6 +1,6 @@
-======================
-Object Spaces
-======================
+================
+The Object Space
+================
.. contents::
@@ -9,7 +9,7 @@
.. _`Object Space`:
Introduction
-================
+============
The object space creates all objects and knows how to perform operations
on the objects. You may think of an object space as being a library
diff --git a/rpython/doc/getting-started.rst b/rpython/doc/getting-started.rst
--- a/rpython/doc/getting-started.rst
+++ b/rpython/doc/getting-started.rst
@@ -49,7 +49,7 @@
.. _`part 2`: http://morepypy.blogspot.com/2011/04/tutorial-part-2-adding-jit.html
-.. _`try out the translator`:
+.. _try-out-the-translator:
Trying out the translator
-------------------------
diff --git a/rpython/doc/glossary.rst b/rpython/doc/glossary.rst
--- a/rpython/doc/glossary.rst
+++ b/rpython/doc/glossary.rst
@@ -9,13 +9,12 @@
annotator
The component of the :term:`RPython toolchain` that performs a form
- of :term:`type inference` on the flow graph. See the `annotator pass`_
+ of :term:`type inference` on the flow graph. See :ref:`annotator`
in the documentation.
backend
- Code generator that converts an `RPython
- <coding-guide.html#restricted-python>`__ program to a `target
- language`_ using the :term:`RPython toolchain`. A backend uses either the
+ Code generator that converts an :doc:`rpython` program to a :ref:`target
+ language <try-out-the-translator>` using the :term:`RPython toolchain`. A backend uses either the
:term:`lltypesystem` or the :term:`ootypesystem`.
compile-time
@@ -28,11 +27,11 @@
implementation will be provided by the backend.
garbage collection framework
- Code that makes it possible to write `PyPy's garbage collectors`_
+ Code that makes it possible to write :doc:`RPython's garbage collectors <garbage_collection>`
in Python itself.
- jit
- `just in time compiler`_.
+ JIT
+ :doc:`just in time compiler <jit/index>`.
llinterpreter
Piece of code that is able to interpret flow graphs. This is very
@@ -63,20 +62,19 @@
promotion
:term:`JIT` terminology. *promotion* is a way of "using" a :term:`run-time`
value at :term:`compile-time`, essentially by deferring compilation
- until the run-time value is known. See if `the jit docs`_ help.
+ until the run-time value is known. See if :doc:`the jit docs <jit/index>` help.
RPython
- `Restricted Python`_, a limited subset of the Python_ language.
+ :ref:`rpython`, a limited subset of the Python_ language.
The limitations make :term:`type inference` possible.
It is also the language that the PyPy interpreter itself is written
in.
RPython toolchain
- The `annotator pass`_, `The RPython Typer`_, and various
- :term:`backend`\ s.
+ :ref:`annotator`, :doc:`rtyper`, and various :term:`backend`\ s.
rtyper
- Based on the type annotations, the `RPython Typer`_ turns the flow
+ Based on the type annotations, :doc:`rtyper` turns the flow
graph into one that fits the model of the target platform/:term:`backend`
using either the :term:`lltypesystem` or the :term:`ootypesystem`.
@@ -98,7 +96,7 @@
source is being analyzed and the JIT itself is being created.
translator
- Tool_ based on the PyPy interpreter which can translate
+ :ref:`Tool <try-out-the-translator>` based on the PyPy interpreter which can translate
sufficiently static Python programs into low-level code.
type system
@@ -108,16 +106,7 @@
Deduces either partially or fully the type of expressions as
described in this `type inference article on Wikipedia`_.
The :term:`RPython toolchain`'s flavour of type inference is described
- in the `annotator pass`_ section.
+ in :ref:`annotator` section.
-.. _`just in time compiler`: jit/index.html
-.. _`the jit docs`: jit/index.html
-.. _`type inference article on Wikipedia`: http://en.wikipedia.org/wiki/Type_inference
-.. _`annotator pass`: translation.html#the-annotation-pass
-.. _`The RPython Typer`: translation.html#the-rpython-typer
-.. _`backends`: getting-started-dev.html#trying-out-the-translator
-.. _Tool: getting-started-dev.html#trying-out-the-translator
-.. _`PyPy's garbage collectors`: garbage_collection.html
-.. _`Restricted Python`: coding-guide.html#restricted-python
+.. _type inference article on Wikipedia: http://en.wikipedia.org/wiki/Type_inference
.. _Python: http://www.python.org
-.. _`RPython Typer`: rtyper.html
diff --git a/rpython/doc/translation.rst b/rpython/doc/translation.rst
--- a/rpython/doc/translation.rst
+++ b/rpython/doc/translation.rst
@@ -267,7 +267,7 @@
.. _`document describing object spaces`: objspace.html
-.. _Annotator:
+.. _annotator:
The Annotation Pass
===================
More information about the pypy-commit
mailing list