add doc for kaldi pybind.

[csukuangfj]

As mentioned in danpovey#87 (comment)
and https://groups.google.com/forum/#!topic/kaldi10-design/BYSkonhkiwc, we are starting to add documentation for kaldi pybind.

The following is a screenshot showing what the generated documentation looks like.

You can access it from https://kaldi-pybind.imfast.io/index.html

---

For developers, you can follow https://github.com/mobvoi/kaldi/blob/fangjun-doc/src/pybind/doc/developers.md to generate documentation locally.

The following is a screenshot from my local computer:

---

@danpovey @jtrmal
please have a reivew.

The generated HTML files can be hosted at https://kaldi-asr.org/doc/
in a subdirectory, say pybind.

[danpovey]

This looks good to me. Of course, the different style vs. doxygen is not ideal, but we have to face the fact that doxygen is getting less popular. Any other comments before I merge?

[csukuangfj]

Doxygen is suitable for generating documentation for C++ code.

Nowadays, I think Sphinx is very popular for generating documentation for Python code.

I find that this project https://exhale.readthedocs.io/en/latest/ can parse Doxygen style
comments into the sphinx domain. Maybe we can convert the current C++ documentation.

Sphinx also supports markdown files.

---

I think we have to upload the generated HTML files to the kaldi doc server.
Is it possible to make this process automatically once a pullrequest is merged?

[danpovey]

We can figure out a workflow to generate and upload the docs. It would be great if someone could work on a docker build that we can enable via travis. This would have to be done for the existing docs first; then, perhaps, the same in a separate directory for the pybind11 branch. @jtrmal to you feel like working on this?

…

On Mon, Mar 2, 2020 at 10:43 AM Fangjun Kuang ***@***.***> wrote: Doxygen is suitable for generating documentation for C++ code. Nowadays, I think Sphinx is very popular for generating documentation for Python code. I find that this project https://exhale.readthedocs.io/en/latest/ can parse Doxygen style comments into the sphinx domain. Maybe we can convert the current C++ documentation. Sphinx also supports markdown files. ------------------------------ I think we have to upload the generated HTML files to the kaldi doc server. Is it possible to make this process automatically once a pullrequest is merged? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#3967?email_source=notifications&email_token=AAZFLO75JWHEIJ2UBK52DH3RFMMN7A5CNFSM4K7GCDU2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOENNWVNA#issuecomment-593193652>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAZFLO6SUFUGJ4XDOVA5LZDRFMMN7ANCNFSM4K7GCDUQ> .

[jtrmal]

yeah i will look at the tomorrow

[danpovey]

Merging this too...

[galv]

A lot of problems with exhale were worked out for the sake of pytorch's C++ interface. It should just work, as the say.