Skip to content
This repository has been archived by the owner on Jul 22, 2023. It is now read-only.

Commit

Permalink
fix link to blog post
Browse files Browse the repository at this point in the history
  • Loading branch information
sdpython committed Jun 11, 2016
1 parent 40752db commit dc59d89
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
26 changes: 26 additions & 0 deletions _doc/sphinxdoc/source/blog/2016/2016-06-11_blogpost_with_label.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@


.. blogpost::
:title: Make a reference to a blog post
:keywords: reference, blog, post
:date: 2016-06-11
:categories: documentation
:lid: label-to-this-blogpost

Option ``lid`` to the directive ``blogpost``
to specify a label. The documentation can now refer to it.

::
.. blogpost::
:title: Make a reference to a blog post
:keywords: reference, blog, post
:date: 2016-06-11
:categories: documentation
:lid: label-to-this-blogpost
And to add a link:

::
:ref:`label-to-this-blogpost`
4 changes: 3 additions & 1 deletion src/project_name/subproject2/myexample2.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
"""
@file
@brief This the documentation of this module (myexample2).
To make a reference to a blog post, just read :ref:`label-to-this-blogpost`.
The following documentation comes from a directive
`runpython <http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/pyquickhelper/helpgen/sphinx_runpython_extension.html>`_
which outputs documentation on the standard output::
Expand Down Expand Up @@ -53,7 +56,6 @@
import project_name
import os
print(os.path.split(project_name.__file__)[-1])
"""
from ..subproject.myexample import myclass

Expand Down

0 comments on commit dc59d89

Please sign in to comment.