Hi, I think Chris mentioned that the RSB has a Markdown implementation:
https://git.rtems.org/rtems-source-builder/tree/source-builder/sb/markdown I am gonna use Markdown since it is good with everybody :) Best, Dannie On Thu, Jun 7, 2018 at 2:21 PM, Joel Sherrill <j...@rtems.org> wrote: > > > On Thu, Jun 7, 2018 at 1:45 PM, Gedare Bloom <ged...@rtems.org> wrote: > >> Hello Chris, Dannie, >> >> I am leaning toward a lighter method such as markdown for the release >> notes. They are not necessary to be a beautifully formatted document. >> Some basic document sectioning, lists, and url support seems >> sufficient to me. This would also be easily parseable by other tools >> in case someone wants to write some further scripts to process the >> release notes, for example, to generate traceability documentation. >> > > > I am OK with using something simple like markdown. The output needs > to be "acceptable", not "beautiful". Plus I expect that there will be > things > in some tickets which are nearly impossible to pass through any processing > and formatter without getting mangled. Might as well keep it simple. > > Is there documentation on the markdown format supported by the RSB? > > I assume it can be used to produce PDF and HTML. > > --joel > > >> >> On Wed, Jun 6, 2018 at 11:55 PM, Dannie Huang <danxue.hu...@gmail.com> >> wrote: >> > Hi Chris, >> > >> > Code is pushed on my github (link is attached below), it would be great >> if >> > you can review it for me! >> > >> > https://github.com/dh0072/ReleaseNotesGenerator >> > >> > I would go to check how Markdown works, thank you! >> > >> > -Dannie >> > >> > On Wed, Jun 6, 2018 at 10:46 PM, Chris Johns <chr...@rtems.org> wrote: >> >> >> >> On 07/06/2018 13:40, Dannie Huang wrote: >> >> > >> >> > Currently data from milestone page and ticket page is stored in >> python >> >> > dictionary, >> >> >> >> This is great. Where is the code so it can be reviewed? >> >> >> >> > how can I convert python dictionary to release notes using sphinx? I >> >> > have checked sphinx documentation but not exactly sure how to do it. >> >> >> >> I am not yet sure ReST and Sphinx is the best solution. We need to >> decide. >> >> >> >> We could use Markdown and get a similar result. The RSB has a Markdown >> >> implementation ... >> >> >> >> https://git.rtems.org/rtems-source-builder/tree/source-build >> er/sb/markdown >> >> >> >> Chris >> > >> > >> > >> > _______________________________________________ >> > devel mailing list >> > devel@rtems.org >> > http://lists.rtems.org/mailman/listinfo/devel >> > >
_______________________________________________ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
