[
https://issues.apache.org/jira/browse/SUBMARINE-518?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17117996#comment-17117996
]
Wangda Tan commented on SUBMARINE-518:
--------------------------------------
We also want to make use of tools like Sphinx to generate static html from
source control file, it will be especially useful for Python-related APIs, etc.
For example: [https://pytorch.org/docs/stable/index.html]
As we're doing more Python SDK API, we also need to get this documentation
versioned since we will have different APIs between versions, and tools like
Sphinx can generate API doc from source file, which help a lot of efforts.
Ideally, documentation can be built nightly so there's always a doc point to
the master branch (Like pytorch example mentioned above).
In the short term, it is fine to make documentation part of Github, but we need
to make a clear structure between these markdown files.
> [Umbrella] Overhaul Submarine Documentation And Website
> -------------------------------------------------------
>
> Key: SUBMARINE-518
> URL: https://issues.apache.org/jira/browse/SUBMARINE-518
> Project: Apache Submarine
> Issue Type: Task
> Reporter: Wangda Tan
> Priority: Major
>
> Now we have a number of issues of our Documentation and Website:
> 1) There's no enough distinguish between website / Github documentation.
> 2) There's no site to host documentation based on versions.
> We need find a way to solve this problem, that's the main purpose of the
> Jira.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
