Skip to content

directive.rst

Latest commit

 

History

History
78 lines (50 loc) · 1.95 KB

directive.rst

File metadata and controls

78 lines (50 loc) · 1.95 KB
Raw

Directive

Attention!

src-trace directive currently only supports :ref:`one-line need definition <oneline>`.

CodeLinks provides src-trace directive and it can be used in the following ways:

.. src-trace::
   :project: project_config
   :file: example.cpp

or

.. src-trace::
   :project: project_config
   :directory: ./example

The src-trace directive has the following options:

  • project: the project config specified in conf.py or TOML file to be used for source tracing.
  • file: the source file to be traced.
  • directory: the source files in the directory to be traced recursively.

Regarding the file and directory options:

  • They are optional and mutually exclusive.
  • The given paths are relative to src_dir defined in the source tracing configuration.
  • If not given, the whole project will be examined.

Example

With the following configuration for a demo source code project dcdc,

src_trace_config_from_toml = "src_trace.toml"
.. literalinclude:: ./../../src_trace.toml
   :caption: src_trace.toml
   :language: toml

The src-trace directive can be used with the file option:

.. src-trace::
   :project: dcdc
   :file: ./charge/demo_1.cpp

The needs defined in source code are extracted and rendered to:

.. src-trace::
   :project: dcdc
   :file: ./charge/demo_1.cpp

The src-trace directive can be used with the directory option:

.. src-trace::
   :project: dcdc
   :directory: ./discharge

The needs defined in source code are extracted and rendered to:

.. src-trace::
   :project: dcdc
   :directory: ./discharge

To have a more customized configuration of CodeLinks, please refer to :ref:`configuration <configuration>`.