Add Sphinx documentation

atmtools / konrad

Implementation of a radiative-convective equilibrium model.

MIT License

19 stars 18 forks source link

Add Sphinx documentation #67

Closed lkluft closed 5 years ago

lkluft commented 5 years ago

This PR:

Adds the infrastructure to build documentation

How-to: 1) Navigate to the docs/ directory 2) Run make html 3) You should find the documentation in docs/build/html

There are still plenty of action items (general look, making the documentation a bit more automated, fix remaining warnings), but it should be good enough as a starting point :wink:

lkluft commented 5 years ago

The whole "Read the Docs" thing will hopefully work after the PR is merged 😉

SallyDa commented 5 years ago

Are you done now? I'm excited :D

lkluft commented 5 years ago

I hope so 😄