search

lvgig / tubular

Python package implementing transformers for pre processing steps for machine learning.
https://tubular.readthedocs.io/en/latest/index.html
BSD 3-Clause "New" or "Revised" License
40 stars 15 forks source link

Add package docs #347

Open davidhopkinson26 opened 4 days ago

davidhopkinson26 commented 4 days ago

Docs have been broken for some time without us realising.

Have seen a number of bugs when trying to fix and the files are very dated now so probably best to start from scratch.

Suggested pathway is to use sphinx to build docs https://www.sphinx-doc.org/en/master/usage/quickstart.html. Autodoc extension for reading docstrings: https://www.sphinx-doc.org/en/master/tutorial/automatic-doc-generation.html

We should also probably set up an readthedocs for business account and host there.

Old docs files cleared up in this PR #348, couple of efforts to fix in #290

davidhopkinson26 commented 4 days ago

Could also consider hosting on github pages