Bug #1261

RST manual (ab)uses Sphinx' Python domain for data types

Added by J. Moringen about 7 years ago. Updated about 2 years ago.

Status:FeedbackStart date:11/26/2012
Priority:LowDue date:
Assignee:-% Done:

0%

Category:documentation
Target version:Robotics Service Bus - rsb-0.18

Description

We generate reStructuredText similar to the following

.. py:class:: rst.audition.SoundChunk

   [...]

   @author [...]

   .. py:attribute:: data

   :type: :py:class:`OCTET-VECTOR`

   [...]

This works OK and renders nicely but is quite wrong semantically.

Is there a solution short of writing a custom Sphinx domain?

History

#1 Updated by S. Wrede about 7 years ago

We could ask Dimitri from Aldebaran robotics about this. He is also a registered users at the code.cor-lab Redmine. Maybe he has an idea, maybe not.

#2 Updated by J. Moringen over 6 years ago

  • Priority changed from Normal to Low
  • Target version changed from rsb-0.9 to rsb-0.10

#3 Updated by J. Moringen almost 6 years ago

  • Target version changed from rsb-0.10 to rsb-0.11

#4 Updated by J. Moringen about 5 years ago

  • Target version changed from rsb-0.11 to rsb-0.12

#5 Updated by J. Wienke over 4 years ago

  • Target version changed from rsb-0.12 to rsb-0.13

#6 Updated by J. Moringen almost 4 years ago

  • Target version changed from rsb-0.13 to rsb-0.14

#7 Updated by J. Moringen over 3 years ago

  • Target version changed from rsb-0.14 to rsb-0.15

#8 Updated by J. Moringen about 3 years ago

  • Target version changed from rsb-0.15 to rsb-0.16

#9 Updated by J. Moringen over 2 years ago

  • Target version changed from rsb-0.16 to rsb-0.17

#10 Updated by J. Moringen about 2 years ago

  • Target version changed from rsb-0.17 to rsb-0.18

Also available in: Atom PDF