OpenHands icon indicating copy to clipboard operation
OpenHands copied to clipboard

Reorganize documentation into Sphinx

Open yimothysu opened this issue 1 year ago • 1 comments

image

Currently, we have all documentation in a docs/ directory. This PR moves the documents into Sphinx to generate a documentation website, which has several advantages:

  1. More structured and clearer organization
  2. More extensible
  3. Better search functionality
  4. Automatic code documentation from docstrings
  5. Easier to navigate on mobile

We can host this on GitHub Pages or ReadTheDocs.

yimothysu avatar Apr 26 '24 02:04 yimothysu

https://github.com/OpenDevin/OpenDevin/pull/1372 seems to overlap with this effort?

C.C. @Sparkier

li-boxuan avatar Apr 26 '24 07:04 li-boxuan

@Sparkier just realized I missed your PR because I started implementing this earlier. Do you have any strong opinions?

I lean towards Sphinx to automatically generate code documentation from Python docstrings, and for integration w/ Python tooling in general.

yimothysu avatar Apr 26 '24 15:04 yimothysu

Hey, I started a slack thread since this is a bigger decision. Hope that's ok with you.

Sparkier avatar Apr 26 '24 16:04 Sparkier

Closing in favor of #1372

yimothysu avatar Apr 26 '24 18:04 yimothysu