sphinx-vb-domain 0.8.2
Sphinx extension to handle Visual Basic Domain.
License: MIT
Requires Python: >=3.8
Keywords: extension, sphinx, vb, visual basic

# sphinx-vb-domain

[≫日本語版](https://github.com/satamame/sphinx-vb-domain/blob/main/README_ja.md)

## Overview

Sphinx extension to handle Visual Basic function directive, and also create the directives from document comments in VB source code.

This project is really experimental. Only features below are working but without any assurance.

## Installation

### pip

```
pip install sphinx-vb-domain
```

### rye

```
rye add --dev sphinx-vb-domain
```

## Usage

### conf.py

Add it to `extensions`.

```python
# conf.py

extensions = [
    'sphinx_vb_domain',
]
```

### Function directive

For example.

```restructuredtext
.. vb:function:: Private Function getId(ByVal name As String, ByVal age As Integer) As Integer
   :module: Module1

   A simple private function.

   :param name: Name
   :type name: String
   :param age: Age
   :type age: Integer
   :returns: Id
   :rtype: Integer

   Remarks here.
```

### Configuration

The following settings can be used in `conf.py`.

#### vb_add_function_labels

```python
vb_add_function_labels = False  # Default: True
```

Setting to `False` disables adding target labels to function directives.  
If you are using `sphinx.ext.autosectionlabel`, you may set this to `False`.  
However, labels in `sphinx-vb-domain` take the form `{module_name}.{function_name}`, so if multiple modules have functions with the same name, you may take this feature.

#### vb_encode_invalid_labels

```python
vb_encode_invalid_labels = False  # Default: True
```

If set to `False`, function names containing invalid characters for Sphinx target labels will not be hash-encoded.  
This setting also applies to explicit labels added to module headings in Autodoc.

#### vb_add_docname_to_labels

```python
vb_add_docname_to_labels = True  # Default: False
```

Setting to `True` adds labels to function directives in the form `{filepath}-{module_name}.{function_name}`, allowing functions with the same name in the same module across multiple files to be distinguished.  
Directory delimiters in `{filepath}` part become `'-'`.  
This setting also applies to explicit labels added to module headings in Autodoc.

#### vb_docname_label_delimiter

```python
vb_docname_label_delimiter = '__'  # Default: '-'
```

`vb_add_docname_to_labels` sets the delimiter that appears after the directory/file names.  
You must specify characters that are valid for Sphinx target labels.  
This setting also applies to explicit labels added to module headings in Autodoc.

#### vb_autodoc_module_labels

```python
vb_autodoc_module_labels = True  # Default: False
```

Setting to `True` adds explicit labels to module headings in Autodoc.

### Autodoc

To create document from VB document comments, following config is needed.

```python
# conf.py

vb_autodoc_paths = [
    (vb_src_dir, page_path, page_title, notes),
]
```

- `vb_src_dir`
    - Path to directory contains VB source, relative from conf.py (e.g. '../../macros').
- `page_path`
    - Path to reST file tobe created, relative from Sphinx source directory (e.g. 'modules' will create 'modules.rst').
- `page_title`
    - Title (level-1 headline) added to e.g. modules.rst.
- `notes`
    - Optional dict to add notes to below targets (dict keys).
        - `'__page__'`: Note to be added under page title.
        - `'<Module name>'`: Note to be added under the module's title.
        - `'<Module name>.<Function name>'`: Note to be added under the function's directive.
    ```python
    # Example
    # Note: Values can be reST, but you should not use headlines.
    notes = {
        '__page__': 'This is note for the page.',
        'Module1': 'This is note for Module1.',
        'Module1.MyFunction': 'This is note for MyFunction.',
    }
    ```

Then, run sphinx-build with `-D vb_autodoc=1` parameter.

In file at `page_path` (e.g. 'modules.rst'), Module (level-2 headline) is created per vb file in `vb_src_dir`, and function directives under the Modules.

#### Notes from template

You can create a template in reST and convert it to dict as notes.

```restructuredtext
__page__
========

This is note for the page.

Module1
-------

This is note for Module1.

Module1.MyFunction
~~~~~~~~~~~~~~~~~~

This is note for MyFunction.
```

Put it in _templates folder, then call `notes_from_template()` function.

```python
# conf.py
from sphinx_vb_domain.utils import notes_from_template

notes = notes_from_template('notes.rst')

vb_autodoc_paths = [
    (vb_src_dir, page_path, page_title, notes),
]
```

### Cross-references

When function directives are rendered, they come with a headline so that the directives appear in toctree.  
Also, when `vb_add_function_labels` is set to `True` (Default), the headline will be a cross-reference target.

#### reStructuredText

```restructuredtext
* :vb:function:`module_name.function_name`
* :any:`module_name.function_name`
* :any:`Link text <module_name.function_name>`
```

#### MyST

```markdown
- {vb:function}`module_name.function_name`
- <project:#module_name.function_name>
- [Link text](#module_name.function_name)
```

## Known issues

- Function directive always rendered in Japanese like follows.
    ```
    Private Function getId(ByVal name As String, ByVal age As Integer) As Integer
    
        A simple private function.

        パラメータ: ・name (String) -- Name
                    ・age (Integer) -- Age
        戻り値: Id
        戻り値の型: Integer

        Remarks here.
    ```
    - You can change `doc_field_types` definition of `VBFunction` class.