search

google-research / dinosaur

Apache License 2.0
211 stars 14 forks source link

create documentation #15

Closed deven367 closed 9 months ago

deven367 commented 9 months ago

Hello,

I saw Stephan's tweet where the team was working on building the documentation for the project, I hope I am not too late in submitting the PR. image

I've included the basic configuration for RTD style documentation. I haven't added CI to build the documentation just yet, I can add that too if necessary. This PR includes,

  1. Additional dependencies added in the toml file
  2. Steps to build the documentation
  3. Generated documentation for the library as of ef01eba96ee9283c9d8e64292f4f291476dcb7f3

Here are some screenshots of the built documentation

image image image

  Please let me know if there something that needs to be changed in this PR. I'll be happy to work on it.

cc @shoyer

shoyer commented 9 months ago

Thanks @deven367 for your interest in helping out here!

This would have been a good thing to consult on first. I don't want to add a doc build with auto-generated API documentation before starting to write narrative documentation. Docs really need manual editing/curation to provide value, which will probably first need to come from us as the original project authors.

So for now, I would rather start with Markdown and Notebook files. When we have enough of these that it would be convenient to put them into HTML, we'll copy over a Sphinx config (e.g., from this PR or what we have working in https://github.com/google/xarray-beam) and setup ReadTheDocs integration.