← Back to team overview

fenics team mailing list archive

Re: [Branch ~fenics-core/fenics-doc/main] Rev 67: Trying to add a link that doesn't work. What am I missing here?

 

On 26 August 2010 15:03,  <noreply@xxxxxxxxxxxxx> wrote:
> ------------------------------------------------------------
> revno: 67
> committer: Anders Logg <logg@xxxxxxxxx>
> branch nick: fenics-doc
> timestamp: Thu 2010-08-26 14:41:15 +0200
> message:
>  Trying to add a link that doesn't work. What am I missing here?
> modified:
>  source/programmers-reference/cpp/index.rst
>  source/styleguides.rst
>
>
> --
> lp:fenics-doc
> https://code.launchpad.net/~fenics-core/fenics-doc/main
>
> You are subscribed to branch lp:fenics-doc.
> To unsubscribe from this branch go to https://code.launchpad.net/~fenics-core/fenics-doc/main/+edit-subscription
>
> === modified file 'source/programmers-reference/cpp/index.rst'
> --- source/programmers-reference/cpp/index.rst  2010-08-26 10:29:13 +0000
> +++ source/programmers-reference/cpp/index.rst  2010-08-26 12:41:15 +0000
> @@ -6,11 +6,12 @@
>  C++ Programmer's Reference
>  ##########################
>
> -This is the index page for the ``C++`` programmer's reference.
> +This is the index page for the C++ programmer's reference.
>  The contents follows the directory structure of DOLFIN.
>
>  .. toctree::
>     :maxdepth: 1
>
> +    :ref:`testing <programmers_reference_cpp_mesh_index>`
> +

You're not supposed to use links in the toctree directive, it's there
to include other rst files and link stuff together.
Note the Sphinx will issue a Warning on build if a file is not
included in a toctree.

http://sphinx.pocoo.org/markup/toctree.html

Kristian

>     mesh/index
> -
>
> === modified file 'source/styleguides.rst'
> --- source/styleguides.rst      2010-08-26 10:15:13 +0000
> +++ source/styleguides.rst      2010-08-26 12:41:15 +0000
> @@ -1,7 +1,5 @@
>  .. Style guides for C++, Python, and documentation
>
> -
> -
>  DOLFIN (C++) and FEniCS documentation (Sphinx).
>
>  .. _styleguides:
> @@ -762,7 +760,7 @@
>  """""""""""""""""""""""""
>
>  The Python ``Mesh`` class is automatically generated by Swig from the DOLFIN
> -C++ implementation and
> +C++ implementation and
>
>
>  Using Sphinx autodoc
>
>
>



Follow ups