docs/en/contribute
zhangxiaowei16 a9ee1207c5 docs: deprecate Sphinx/Doxygen toolchain, migrate to pure Markdown
Previously openvela API documentation was built via Doxygen + Breathe + Sphinx,
requiring a complex toolchain and generating 180MB of intermediate artifacts.
Since all module-level API documentation (kernel, bluetooth, media, telephony,
feature, etc.) has been refactored to hand-written Markdown, the toolchain is
no longer necessary.

This commit deprecates the Sphinx/Doxygen build pipeline in favor of pure
Markdown browsing on GitHub.

Removed:
  - Doxyfile.public (Doxygen config, 113KB)
  - conf.py / Makefile / make.bat / requirements.txt / index.rst (Sphinx config)
  - _static/logo/openvela.svg (Sphinx static asset)
  - api_doc_generation_guide.md in both zh-cn/ and en/ (Doxygen+Sphinx tutorials)

Updated:
  - All index.md files: removed 'eval_rst toctree' blocks, added plain
    Markdown navigation lists
  - keystore_client.md: removed doxygenfile directive (placeholder note added
    pointing to source header, pending full rewrite)

Added:
  - .gitignore: prevent accidental commit of build artifacts (_build/,
    doxygen/doxygen/, Python/editor temp files)

Follow-up:
  - services/ams.md and services/pms.md still contain doxygenfile directives
    and need full manual rewrite (separate PR)
  - .github/workflows/docs.yml may need to be updated or removed to stop
    invoking the deprecated Sphinx build
2026-05-07 20:41:53 +08:00
..
process Add openvela Highlights 2026-02-06 11:35:13 +08:00
template Optimizing English Documentation Translation 2025-09-28 16:59:08 +08:00
code_style_check_guide.md Optimize document content 2025-09-10 20:20:56 +08:00