timothyb0912 / pylogit

A python package for estimating conditional logit models.

https://pypi.org/project/pylogit/

BSD 3-Clause "New" or "Revised" License

186 stars 103 forks source link

Online documentation #57

Open timothyb0912 opened 4 years ago

timothyb0912 commented 4 years ago

Request

Create online documentation as in a readthedocs page or something similar.

timothyb0912 commented 3 years ago

Ah, see pdocs for easy, automatic, online-documentation creation from project docstrings. See pytikz for a real and minimal project showing how to use pdoc3.

This should be combined with interrogate to automatically discover which parts of the codebase are missing docstrings. This will help keep the documentation up to date.

timothyb0912 commented 3 years ago

See mkdocs for "manual" building of documentations sites. See portray for combining pdocs and mkdocs.