Automatically generate Python API docs

spirit-code / spirit

Atomistic Spin Simulation Framework

http://spirit-code.github.io

MIT License

117 stars 52 forks source link

Automatically generate Python API docs #487

Closed GPMueller closed 5 years ago

GPMueller commented 5 years ago

Instead of having manually written documentation, it would be better to automatically generate it to always be up to date.

See for example the AiiDA API docs, generated in the conf.py for readthedocs.

pdoc seems to also work ok, but probably harder to integrate in readthedocs.

GPMueller commented 5 years ago

This has been fully implemented since189b8d42c522dc0cbaae51eff3047f227ff471e3 on feature-auto-docs, merged with d1679f90a7e57824bfa1a4af8476087061bdf094.