Select a documentation generation tool

rdkcentral / python_raft

RAFT is a Python based testing framework for writing engineering tests. It provides a modular, config driven, low level testing framework

Apache License 2.0

2 stars 0 forks source link

Select a documentation generation tool #4

Open barbourshop opened 3 months ago

barbourshop commented 3 months ago

Goal: To choose a tool to autogenerate HTML documentation from code.

Potentially suitable tools to evaluate

Doxygen
- example using Doxygen to document pyton
Sphinx

Acceptance Criteria:

output must be in an HTML format suitable for display via Github pages
documentation generation process must be completable via gh action

TB-1993 commented 2 months ago

The current suggestion for this is to use a combination of Doxygen and Sphinx using the Breathe plugin for Sphinx.

So far we've found that Doxygen will collate documents together better/easier than sphinx, but the documentation and styling sphinx provides is more standard for python and doesn't require us to use non-pythonic comments in our docstrings.