search

LSSTDESC / firecrown

DESC Cosmology Likelihood Framework
BSD 3-Clause "New" or "Revised" License
30 stars 7 forks source link

First version of Sphinx support. #157

Closed vitenti closed 2 years ago

vitenti commented 2 years ago

It needs several tweaks and all the static documentation.

marcpaterno commented 2 years ago

I have verified that I can build the documentation. I had to install 3 packages into my conda environment: sphinx, sphinx-autodoc-typehints, and sphinx_rtd_theme. With these, I was able to generate HTML documentation. I'm not sure what else is needed to generate the PDF (LaTeX) documentation, or whether we want to support that.

We should produce a list of required module installations for developers who want to test the generation of documentation, unless we plan on adding all those modules to our "regular" installation. My inclination is to not include them in our "regular" installation, just to keep the size down. I am willing to be convinced otherwise.

marcpaterno commented 2 years ago

I pushed the wrong button (close with comment, rather than just comment and then merge & close).