Apply Sun Lab conventions to Sphinx documentation files and configurations.
npx skills add https://github.com/Sun-Lab-NBB/ataraxis --skill api-docs-sun-lab-nbb
Please help me install this Agent Skill. Skill: api-docs Source: https://github.com/Sun-Lab-NBB/ataraxis/tree/main/plugins/automation/skills/api-docs Command: npx skills add https://github.com/Sun-Lab-NBB/ataraxis --skill api-docs-sun-lab-nbb
This Skill ensures that API documentation for Sun Lab projects adheres to established conventions, making it consistent, discoverable, and easy to maintain across different projects.
conf.py for Python-only, C++-only, and hybrid projects.index.rst, welcome.rst, and api.rst files.Apply Sun Lab API documentation conventions to the current project's Sphinx files.
High-intent search queries and answers about installing and using this skill.
Sphinx documentation for hybrid projects requires configuring conf.py to integrate Doxygen and Breathe, defining standard RST structures like index.rst and api.rst, and setting up tox build environments to generate consistent API docs.
Doxygen integration with Sphinx using Breathe works by configuring Breathe in conf.py to parse Doxygen XML output, allowing C++ API documentation to be rendered directly within standard Sphinx RST documentation files.
The standard RST structure for Sphinx API documentation includes defining root index.rst files alongside dedicated welcome.rst and api.rst files to organize project overviews and reference documentation hierarchically.
Yes, this Sphinx configuration supports Python-only project archetypes by setting up conf.py and standard RST files without requiring Doxygen or Breathe integration, ensuring consistent documentation generation across different project types.
Standardizing API documentation across multiple projects involves applying consistent Sphinx conventions for conf.py, RST structure, Doxygen/Breathe integration, and tox build environments to make docs discoverable and easy to maintain.
A Makefile wrapper is used to standardize Sphinx documentation builds with tox environments, providing a consistent entry point for generating documentation across Python-only, C++-only, and hybrid project archetypes.
bossjonesGenerate markdown documentation from Python source files, docstrings, and type hints.
xshi19Build and deploy Sphinx-generated documentation to the gh-pages branch via GitHub Actions.
julianobarbosaReview code for quality, bugs, security issues, and best practices using Codex.
aselimcFetch and convert HTML documentation pages to Markdown.