معرفی شرکت ها

clang-api-doc-0.4.0

Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
Card image cap
تبلیغات ما

مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.

مشاهده بیشتر
0.4.0
0.3.0
0.2.0
0.1.0
0.4.0
0.3.0
0.2.0
0.1.0

توضیحات

Automatically generate API documentation for C language dialects
ویژگی مقدار
سیستم عامل -
نام فایل clang-api-doc-0.4.0
نام clang-api-doc
نسخه کتابخانه 0.4.0
نگهدارنده []
ایمیل نگهدارنده []
نویسنده Gideon Müller
ایمیل نویسنده gpmueller@outlook.com
آدرس صفحه اصلی https://github.com/gpmueller/clang-api-doc
آدرس اینترنتی https://pypi.org/project/clang-api-doc/
مجوز MIT
clang-api-doc ============================= Generate C API documentation using libclang Python bindings. For an example see the [documentation](https://clang-api-doc.readthedocs.io). [![PyPI version](https://badge.fury.io/py/clang-api-doc.svg)](https://badge.fury.io/py/clang-api-doc) [![CI](https://github.com/GPMueller/clang-api-doc/actions/workflows/ci.yml/badge.svg)](https://github.com/GPMueller/clang-api-doc/actions/workflows/ci.yml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/61ce78fd4cbc41c29ec8eace9bdedca5)](https://www.codacy.com/gh/GPMueller/clang-api-doc/dashboard?utm_source=github.com&utm_medium=referral&utm_content=GPMueller/clang-api-doc&utm_campaign=Badge_Grade) Why? ----------------------------- Ideally, code should be self-documenting. To me that means little to no documentation should be needed in the code itself, as it strongly tends to harm readability if the code already explains itself. The remaining use-cases for documentation are typically - **API references**, in particular assumed usage contracts - usage examples - installation instructions - general introductions This project focuses on generating API references, as the other use-cases tend to be written separate from the code. The markdown-files generated by `clang-api-doc` can be used in any way you wish to create your final documentation, for example - `mkdocs` - `sphinx` - transform to a different format using `pandoc` Installation ----------------------------- The `clang-api-doc` package is on PyPI, so you can use `pip`, `poetry`, or whatever you like to install it, for example `pip install clang-api-doc`. To install it locally and in editable mode, simply install poetry and run `poetry install` and to load the virtual environment run `poetry shell`. CLI usage ----------------------------- Simply call `clang-api-doc` once per file you wish to document, e.g. ```bash clang-api-doc -i 'include/mylib/first.h' -o 'docs/first.md' clang-api-doc -i 'include/mylib/second.h' -o 'docs/second.md' ``` or once per folder, e.g. ```bash clang-api-doc -i 'include/mylib/' -o 'docs/' ``` Python package usage ----------------------------- ```python from clang_api_doc import clang_api_doc for file_in, file_out in zip(input_files, output_files): clang_api_doc.transform_file(file_in, file_out) ```


نیازمندی

مقدار نام
- clang


زبان مورد نیاز

مقدار نام
>=3.6,<4.0 Python


نحوه نصب


نصب پکیج whl clang-api-doc-0.4.0:

    pip install clang-api-doc-0.4.0.whl


نصب پکیج tar.gz clang-api-doc-0.4.0:

    pip install clang-api-doc-0.4.0.tar.gz