freetype-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [ft-devel] actually converting FreeType documentation to markdown


From: Nikhil Ramakrishnan
Subject: Re: [ft-devel] actually converting FreeType documentation to markdown
Date: Sun, 22 Jul 2018 18:26:02 +0530

Hi,

how shall we do the conversion of the API documentation (in the header
files) to markdown?  What steps do you recommend?

Once we convert the documentation to markdown, it will become
incompatible with the current docmaker. I suggest the following:

1. Create a separate branch and push docwriter along with changes to
the makefiles.

2. Convert documentation in the branch to markdown. Updates to the
header files in master can continue normally.

3. Once this is tested and verified, we can revert changes to the
header files, rebase new changes from master and reapply 'markify'
before finally merging this branch to master.

With these steps, the transition should be smooth. If there are any
other suggestions, please let me know!


--
Nikhil

reply via email to

[Prev in Thread] Current Thread [Next in Thread]