This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Inline Markup :const: shows up in Documentation
Type: behavior Stage:
Components: Documentation tools (Sphinx) Versions: Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, wplappert
Priority: normal Keywords:

Created on 2008-10-22 06:39 by wplappert, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (2)
msg75063 - (view) Author: Winfried Plappert (wplappert) Date: 2008-10-22 06:39
The Inline Markup :const: shows up in the final documentation. Example
can be found on http://docs.python.org/library/select.html :

kevent.fflags¶

    Filter specific flags

    :const:`KQ_FILTER_READ` and :const:`KQ_FILTER_WRITE` filter flags
    Constant 	Meaning
    KQ_NOTE_LOWAT 	low water mark of a socket buffer

    :const:`KQ_FILTER_VNODE` filter flags

It also shows up in the equivalent PDF documentation. The underlying rst
file is library/select.rst, relevant part of source text follows:
   *:const:`KQ_FILTER_READ` and  :const:`KQ_FILTER_WRITE` filter flags*

  
+----------------------------+--------------------------------------------+
   | Constant                   | Meaning                              
     |
  
+============================+============================================+
   | :const:`KQ_NOTE_LOWAT`     | low water mark of a socket buffer    
     |
  
+----------------------------+--------------------------------------------+


   *:const:`KQ_FILTER_VNODE` filter flags*


There is one more occurrance of :const: in
http://docs.python.org/library/cookielib.html:
...
Cookie.is_expired([now=:const:`None`])¶
    True if cookie ...
msg75506 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008-11-04 20:49
Thanks, fixed in r67101.
History
Date User Action Args
2022-04-11 14:56:40adminsetgithub: 48417
2008-11-04 20:49:43georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg75506
2008-10-22 06:39:14wplappertcreate