search

xgcm / xcape

Fast convective parameters for numpy, dask, and xarray
Other
30 stars 11 forks source link

set up documentation building #29

Closed rabernat closed 4 years ago

rabernat commented 4 years ago

Here are the steps.

  1. First, learn to build the documentation locally. It lives in the doc folder. We use sphinx. The command to build it is make html (from the doc folder). To preview your local docs, do cd _build/html; python -m http.server.
  2. Then configure readthedocs. You will need to create a .readthedocs.yml file. (example)
xebadir commented 4 years ago

Took a first crack at this in the branch #32 - successfully did step 1 for initial data, and ran into issues with the building via ReadTheDocs for the forked version as a test due to the fortran dependencies. Guidance I've found online suggests we may need to look at the mock autodocs procedure to deal with this in order to get a successful build. Result of build was this log: https://readthedocs.org/projects/xcape-test/builds/11707078/? May also be an issue with the permissions on the Webhooks.

chiaral commented 4 years ago

This is done with #36