APrioriInvestments / typed_python

An llvm-based framework for generating and calling into high-performance native code from Python.
Apache License 2.0
197 stars 8 forks source link

Add readthedocs support #399

Open wllgrnt opened 1 year ago

wllgrnt commented 1 year ago

Motivation and Context

Once merged, this will allow the Sphinx docs in docs/ (and the docstrings) to be built and served at typed-python.readthedocs.io. With an appropriate webhook the docs would be rebuilt automatically with every commit to dev but that's a separate discussion.

Apologies for the many commits - the RTD/sphinx-apidoc documentation is sparse, and learning which shells RTD and Make like to use, and which of those support the globstar operator, was non-trivial.

How Has This Been Tested?

This branch's docs are viewable at https://typed-python.readthedocs.io/en/will_grant-add_markdown_rtd_support/. Will delete once merged.

Types of changes

Checklist:

wllgrnt commented 1 year ago

(We can hang fire on this until the docs are in a better state)

braxtonmckee commented 1 year ago

This looks good. Can we squash it down to one commit and then i'll merge it?