DEPRECATED icon indicating copy to clipboard operation
DEPRECATED copied to clipboard

Automatic Documentation Generation for All Repositories

Open iamtrask opened this issue 8 years ago • 3 comments
trafficstars

Background: We're building an advanced ecosystem of repositories that all need to communicate with each other. This means that Contributors in one repository would benefit greatly by being able to read short descriptions about functionality occurring in another repository. In this Epic, we want to accomplish automatic Documentation generation for all of our repositories across OpenMined.

Acceptance Criteria:

  • All repositories have a hosted documentation page that autobuilds as a subdomain of our website based on the name of the repository. (i.e., something like docs.openmined.org/pysyft OR pysyft.docs.openmined.org)

iamtrask avatar Sep 07 '17 19:09 iamtrask

I assume the target audience is developers here. Why do we need it to be websites and not just markdown?

anoff avatar Sep 07 '17 19:09 anoff

cuz it can be so pretty!!! pytorch.org/docs/master/tensors.html

iamtrask avatar Sep 07 '17 20:09 iamtrask

How can we automated? I mean, which tool we should use to achieve this goal?

lucaslopes avatar Jan 20 '18 21:01 lucaslopes