Use Sphinx and Breathe (+Doxygen) for documentation
Open
@simonsan is already working on this.
Since Sep 6, 2019.
documentation
just do it
nice new thing ☺
- Dominant language
- Python
- Stars
- 14.4k
- Forks
- 1.3k
- PR merge metrics
- No merged PRs in 30d
Description
Currently, we have Doxygen to generate our inline C++ documentation (libopenage/). We also use it for the Python code (openage/), but we should switch to Sphinx for this.
To beautify our doc/ folder, we could use Sphinx.
To link between both, there is Breathe.
For more automatization (file hierarchy, ...), we can use Exhale.
Then we would have a nice and one-for-all documentation by Sphinx: It natively support Python, the C++ parsing is still done by Doxygen which would be nicely integrated via breathe.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.