Commits

Gregor Wegberg committed cb5d668

fix sphinx-doc warnings because of missing ref

These refs did never work and did not point to the bitbucket directory.
For now, just use backquotes.

  • Participants
  • Parent commits f8ede69
  • Branches latest-improve-doc

Comments (4)

    1. Gregor Wegberg author

      It appears to be a problem with the python script that should generate hyperlinks to bitbucket. I realised this fact just after committing this changeset and did a backout in 6cf6b79. I don't know what the state is.

      1. anatoly techtonik

        Looks like it is tool/makeref.py, which should be called during doc/ build process, but RTD uses conf.py directly, and it doesn't present in makefiles, so probably this never happens and makeref.py is called manually.

        Anyway, this is properly fixed in ff6ad0e106d9 by including generated _ref.txt

Files changed (1)

File pypy/doc/dir-reference.rst

 =================================  ============================================
 Directory                          explanation/links
 =================================  ============================================
-`pypy/bin/`_                       command-line scripts, mainly
+``pypy/bin/``                       command-line scripts, mainly
                                    `pypy/bin/pyinteractive.py`_
 
-`pypy/config/`_                    handles the numerous options for building
+``pypy/config/``                    handles the numerous options for building
                                    and running PyPy
 
-`pypy/doc/`_                       text versions of PyPy developer
+``pypy/doc/``                       text versions of PyPy developer
                                    documentation
 
-`pypy/doc/config/`_                documentation for the numerous translation
+``pypy/doc/config/``                documentation for the numerous translation
                                    options
 
-`pypy/doc/discussion/`_            drafts of ideas and documentation
+``pypy/doc/discussion/``            drafts of ideas and documentation
 
 ``doc/*/``                         other specific documentation topics or tools
 
-`pypy/interpreter/`_               `bytecode interpreter`_ and related objects
+``pypy/interpreter/``               `bytecode interpreter`_ and related objects
                                    (frames, functions, modules,...)
 
-`pypy/interpreter/pyparser/`_      interpreter-level Python source parser
+``pypy/interpreter/pyparser/``      interpreter-level Python source parser
 
-`pypy/interpreter/astcompiler/`_   interpreter-level bytecode compiler,
+``pypy/interpreter/astcompiler/``   interpreter-level bytecode compiler,
                                    via an AST representation
 
-`pypy/module/`_                    contains `mixed modules`_
+``pypy/module/``                    contains `mixed modules`_
                                    implementing core modules with
                                    both application and interpreter level code.
                                    Not all are finished and working.  Use
                                    or ``--allworkingmodules`` translation
                                    options.
 
-`pypy/objspace/`_                  `object space`_ implementations
+``pypy/objspace/``                  `object space`_ implementations
 
-`pypy/objspace/std/`_              the StdObjSpace_ implementing CPython's
+``pypy/objspace/std/``              the StdObjSpace_ implementing CPython's
                                    objects and types
 
-`pypy/tool/`_                      various utilities and hacks used
+``pypy/tool/``                      various utilities and hacks used
                                    from various places
 
-`pypy/tool/algo/`_                 general-purpose algorithmic and mathematic
+``pypy/tool/algo/``                 general-purpose algorithmic and mathematic
                                    tools
 
-`pypy/tool/pytest/`_               support code for our `testing methods`_
+``pypy/tool/pytest/``               support code for our `testing methods`_
 
 
-`rpython/annotator/`_              `type inferencing code`_ for
+``rpython/annotator/``              `type inferencing code`_ for
                                    `RPython`_ programs
 
-`rpython/config/`_                 handles the numerous options for RPython
+``rpython/config/``                 handles the numerous options for RPython
 
 
-`rpython/flowspace/`_              the FlowObjSpace_ implementing
+``rpython/flowspace/``              the FlowObjSpace_ implementing
                                    `abstract interpretation`_
 
-`rpython/rlib/`_                   a `"standard library"`_ for RPython_
+`rpython/rlib/``                   a `"standard library"`_ for RPython_
                                    programs
 
-`rpython/rtyper/`_                 the `RPython Typer`_
+``rpython/rtyper/``                 the `RPython Typer`_
 
-`rpython/rtyper/lltypesystem/`_    the `low-level type system`_ for
+``rpython/rtyper/lltypesystem/``    the `low-level type system`_ for
                                    C-like backends
 
-`rpython/memory/`_                 the `garbage collector`_ construction
+``rpython/memory/``                 the `garbage collector`_ construction
                                    framework
 
-`rpython/translator/`_             translation_ backends and support code
+``rpython/translator/``             translation_ backends and support code
 
-`rpython/translator/backendopt/`_  general optimizations that run before a
+``rpython/translator/backendopt/``  general optimizations that run before a
                                    backend generates code
 
-`rpython/translator/c/`_           the `GenC backend`_, producing C code
+``rpython/translator/c/``           the `GenC backend`_, producing C code
                                    from an
                                    RPython program (generally via the rtyper_)
 
-`pypy/goal/`_                      our `main PyPy-translation scripts`_
+``pypy/goal/``                      our `main PyPy-translation scripts`_
                                    live here
 
-`rpython/translator/tool/`_        helper tools for translation
+``rpython/translator/tool/``        helper tools for translation
 
-`dotviewer/`_                      `graph viewer`_
+``dotviewer/``                      `graph viewer`_
 
 ``*/test/``                        many directories have a test subdirectory
                                    containing test