Skip to content

README.rst

Latest commit

 

History

History
118 lines (75 loc) · 2.74 KB

README.rst

File metadata and controls

118 lines (75 loc) · 2.74 KB

LinuxDoc

The LinuxDoc library contains Sphinx-doc extensions and command line tools to extract documentation from C/C++ source file comments. Even if this project started in context of the Linux-Kernel documentation, you can use these extensions in common Sphinx-doc projects.

linuxdoc is distributed under the terms of the AGPL-3.0-or-later license.

Install

Install LinuxDoc using pip:

pip install --user -U linuxdoc

Development

This project is managed by hatch, for development tasks you should install hatch:

pipx install hatch

The tools required for the developer environment are provided in the mise.toml configuration file (Mise En Place).

git clone https://codeberg.org/return42/linuxdoc.git
cd linuxdoc
mise install

Format and lint your code before commit:

hatch run fix
hatch run check

To enter the development environment use shell dev:

hatch shell dev

To get a live build of documentation:

hatch run doc:live

For project tasks & maintenance use:

hatch run prj
# (.venv)$ mt4os --help

For example, to get a live build of documentation:

hatch run prj doc.live

Mise En Place

For the developer environment, mise en place is recommended:

$ curl https://mise.run | sh

# to install shell completions .. and mises's backends dependencies
$ mise use -g usage

To activate mise in the current bash session see mise activate --help. For a more streamlined setup, you can configure activation in your shell's configuration file.

For the Bash shell, the following lines can be added to the ~/.bashrc file:

if [ -f "${HOME}/.local/bin/mise" ]; then
    eval "$("${HOME}/.local/bin/mise" activate bash --shims)"
fi

Links