Author: Manuel Jacob
Branch: improve-docs
Changeset: r63886:c8722dd21e7b
Date: 2013-05-06 16:01 +0200
http://bitbucket.org/pypy/pypy/changeset/c8722dd21e7b/
Log: Use sphinx' extlinks extension in pypy/doc/, too.
diff --git a/pypy/doc/conf.py b/pypy/doc/conf.py
--- a/pypy/doc/conf.py
+++ b/pypy/doc/conf.py
@@ -22,7 +22,7 @@
# 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.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.ifconfig',
'sphinx.ext.graphviz', 'pypyconfig']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
'sphinx.ext.extlinks', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
'sphinx.ext.ifconfig', 'sphinx.ext.graphviz', 'pypyconfig']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -204,3 +204,5 @@
u'fast, compliant alternative implementation of the Python language',
u'The PyPy Project', 1)
]
+
+extlinks = {'source': ('https://bitbucket.org/pypy/pypy/src/default/%s', '')}
diff --git a/pypy/doc/dir-reference.rst b/pypy/doc/dir-reference.rst
--- a/pypy/doc/dir-reference.rst
+++ b/pypy/doc/dir-reference.rst
@@ -4,105 +4,105 @@
Here is a fully referenced alphabetical two-level deep
directory overview of PyPy:
-================================= ============================================
-Directory explanation/links
-================================= ============================================
-`pypy/bin/`_ command-line scripts, mainly
- `pypy/bin/pyinteractive.py`_
+========================================
============================================
+Directory explanation/links
+========================================
============================================
+:source:`pypy/bin/` command-line scripts, mainly
+ :source:`pypy/bin/pyinteractive.py`
-`pypy/config/`_ handles the numerous options for building
- and running PyPy
+:source:`pypy/config/` handles the numerous options for
building
+ and running PyPy
-`pypy/doc/`_ text versions of PyPy developer
- documentation
+:source:`pypy/doc/` text versions of PyPy developer
+ documentation
-`pypy/doc/config/`_ documentation for the numerous translation
- options
+:source:`pypy/doc/config/` documentation for the numerous
translation
+ options
-`pypy/doc/discussion/`_ drafts of ideas and documentation
+:source:`pypy/doc/discussion/` drafts of ideas and documentation
-``doc/*/`` other specific documentation topics or tools
+``doc/*/`` other specific documentation topics
or tools
-`pypy/interpreter/`_ `bytecode interpreter`_ and related objects
- (frames, functions, modules,...)
+:source:`pypy/interpreter/` `bytecode interpreter`_ and related
objects
+ (frames, functions, modules,...)
-`pypy/interpreter/pyparser/`_ interpreter-level Python source parser
+:source:`pypy/interpreter/pyparser/` interpreter-level Python source
parser
-`pypy/interpreter/astcompiler/`_ interpreter-level bytecode compiler,
- via an AST representation
+:source:`pypy/interpreter/astcompiler/` interpreter-level bytecode compiler,
+ via an AST representation
-`pypy/module/`_ contains `mixed modules`_
- implementing core modules with
- both application and interpreter level code.
- Not all are finished and working. Use
- the ``--withmod-xxx``
- or ``--allworkingmodules`` translation
- options.
+:source:`pypy/module/` contains `mixed modules`_
+ implementing core modules with
+ both application and interpreter
level code.
+ Not all are finished and working.
Use
+ the ``--withmod-xxx``
+ or ``--allworkingmodules``
translation
+ options.
-`pypy/objspace/`_ `object space`_ implementations
+:source:`pypy/objspace/` `object space`_ implementations
-`pypy/objspace/std/`_ the StdObjSpace_ implementing CPython's
- objects and types
+:source:`pypy/objspace/std/` the StdObjSpace_ implementing
CPython's
+ objects and types
-`pypy/tool/`_ various utilities and hacks used
- from various places
+:source:`pypy/tool/` various utilities and hacks used
+ from various places
-`pypy/tool/algo/`_ general-purpose algorithmic and mathematic
- tools
+:source:`pypy/tool/algo/` general-purpose algorithmic and
mathematic
+ tools
-`pypy/tool/pytest/`_ support code for our `testing methods`_
+:source:`pypy/tool/pytest/` support code for our `testing
methods`_
-`rpython/annotator/`_ `type inferencing code`_ for
- `RPython`_ programs
+:source:`rpython/annotator/` `type inferencing code`_ for
+ `RPython`_ programs
-`rpython/config/`_ handles the numerous options for RPython
+:source:`rpython/config/` handles the numerous options for
RPython
-`rpython/flowspace/`_ the FlowObjSpace_ implementing
- `abstract interpretation`_
+:source:`rpython/flowspace/` the FlowObjSpace_ implementing
+ `abstract interpretation`_
-`rpython/rlib/`_ a `"standard library"`_ for RPython_
- programs
+:source:`rpython/rlib/` a `"standard library"`_ for RPython_
+ programs
-`rpython/rtyper/`_ the `RPython Typer`_
+:source:`rpython/rtyper/` the `RPython Typer`_
-`rpython/rtyper/lltypesystem/`_ the `low-level type system`_ for
- C-like backends
+:source:`rpython/rtyper/lltypesystem/` the `low-level type system`_ for
+ C-like backends
-`rpython/rtyper/ootypesystem/`_ the `object-oriented type system`_
- for OO backends
+:source:`rpython/rtyper/ootypesystem/` the `object-oriented type system`_
+ for OO backends
-`rpython/memory/`_ the `garbage collector`_ construction
- framework
+:source:`rpython/memory/` the `garbage collector`_ construction
+ framework
-`rpython/translator/`_ translation_ backends and support code
+:source:`rpython/translator/` translation_ backends and support
code
-`rpython/translator/backendopt/`_ general optimizations that run before a
- backend generates code
+:source:`rpython/translator/backendopt/` general optimizations that run
before a
+ backend generates code
-`rpython/translator/c/`_ the `GenC backend`_, producing C code
- from an
- RPython program (generally via the rtyper_)
+:source:`rpython/translator/c/` the `GenC backend`_, producing C code
+ from an
+ RPython program (generally via the
rtyper_)
-`rpython/translator/cli/`_ the `CLI backend`_ for `.NET`_
- (Microsoft CLR or Mono_)
+:source:`rpython/translator/cli/` the `CLI backend`_ for `.NET`_
+ (Microsoft CLR or Mono_)
-`pypy/goal/`_ our `main PyPy-translation scripts`_
- live here
+:source:`pypy/goal/` our `main PyPy-translation scripts`_
+ live here
-`rpython/translator/jvm/`_ the Java backend
+:source:`rpython/translator/jvm/` the Java backend
-`rpython/translator/tool/`_ helper tools for translation
+:source:`rpython/translator/tool/` helper tools for translation
-`dotviewer/`_ `graph viewer`_
+:source:`dotviewer/` `graph viewer`_
-``*/test/`` many directories have a test subdirectory
- containing test
- modules (see `Testing in PyPy`_)
+``*/test/`` many directories have a test
subdirectory
+ containing test
+ modules (see `Testing in PyPy`_)
-``_cache/`` holds cache files from various purposes
-================================= ============================================
+``_cache/`` holds cache files from various
purposes
+========================================
============================================
.. _`bytecode interpreter`: interpreter.html
.. _`Testing in PyPy`: coding-guide.html#testing-in-pypy
_______________________________________________
pypy-commit mailing list
[email protected]
http://mail.python.org/mailman/listinfo/pypy-commit
