search

patbat / khuri

Khuri-Treiman equations / dispersion relations
GNU General Public License v3.0
1 stars 0 forks source link

Incorporate source code documentation into read the docs #4

Open patbat opened 5 years ago

patbat commented 5 years ago

The source code is documented ether via doxygen-like comments (this holds true for the c++ code) or via python docstrings. It might (!) be a good idea to include this documentation in an automatic fashion in the readthedocs documentation.

patbat commented 4 years ago

At least for the docstrings it is indeed a good idea.

patbat commented 4 years ago

Use sphyinx autodoc.

patbat commented 4 years ago

Even better: sphinx-apidoc.

patbat commented 4 years ago

While the offline build works fine, integration with readthedocs does not. That is, there is no documentation generated from the docstrings online accessible. One idea to get this going is to tell readthedocs to build khuri. However, this is not straightforward, for the building process requires cmake and external libraries.

Is there an easy way to have the api documenation online?