My bad. I knew it's Sphinx generated, although had no idea it's in sync
with Github :) There is also no mention of it on github (a badge would be
nice) - Pull Request coming.
----
Pozdrawiam, | Best regards,
Maciek Wójcikowski
[email protected]
2015-03-13 16:10 GMT+01:00 Greg Landrum <[email protected]>:
> You mean like the docs that are already there?
> The links that David provided are to docs that are built on Sphinx. Those
> are also available, without the API documentation from ReadTheDocs (
> https://readthedocs.org/projects/rdkit/)
>
> My solution for keeping the docs as up-to-date as possible is to include
> doctests in them. This isn't perfect, but it's the best I've found.
>
> -greg
>
>
>
> On Fri, Mar 13, 2015 at 3:52 PM, Maciek Wójcikowski <[email protected]
> > wrote:
>
>> I vote for setting up readthedocs.org automatic documentation
>> generation, plus some sphinx API docs. All we need to do then is to keep
>> track of changes and create solid docstrings.
>>
>> ----
>> Pozdrawiam, | Best regards,
>> Maciek Wójcikowski
>> [email protected]
>>
>> 2015-03-13 15:43 GMT+01:00 David Hall <[email protected]>:
>>
>>> well, presumably the documentation not in the wiki would continue to be
>>> online.
>>>
>>> http://rdkit.org/docs/index.html
>>> http://rdkit.org/docs/api/index.html
>>> http://rdkit.org/docs/cppapi/index.html
>>>
>>> None of those are the wiki and tend to be more up-to-date.
>>>
>>> -David
>>>
>>>
>>> On Mar 13, 2015, at 10:39 AM, Dimitri Maziuk <[email protected]>
>>> wrote:
>>>
>>> On 2015-03-13 01:25, Greg Landrum wrote:
>>>
>>> Github does offer the option of setting up a wiki for a project, I
>>> haven't done this for the RDKit since it doesn't seem that necessary
>>> (and it seems that the information in wikis has a tendency to "rot") but
>>> if anyone has strong opinion otherwise, we can get something set up.
>>>
>>>
>>> Documentation has a tendency to go out of date whether it's in wiki
>>> format or not. What's the proposed alternative: not have any
>>> documentation online at all?
>>>
>>> Dimitri
>>>
>>>
>>>
>>> ------------------------------------------------------------------------------
>>> Dive into the World of Parallel Programming The Go Parallel Website,
>>> sponsored
>>> by Intel and developed in partnership with Slashdot Media, is your hub
>>> for all
>>> things parallel software development, from weekly thought leadership
>>> blogs to
>>> news, videos, case studies, tutorials and more. Take a look and join the
>>> conversation now. http://goparallel.sourceforge.net/
>>> _______________________________________________
>>> Rdkit-discuss mailing list
>>> [email protected]
>>> https://lists.sourceforge.net/lists/listinfo/rdkit-discuss
>>>
>>>
>>>
>>>
>>> ------------------------------------------------------------------------------
>>> Dive into the World of Parallel Programming The Go Parallel Website,
>>> sponsored
>>> by Intel and developed in partnership with Slashdot Media, is your hub
>>> for all
>>> things parallel software development, from weekly thought leadership
>>> blogs to
>>> news, videos, case studies, tutorials and more. Take a look and join the
>>> conversation now. http://goparallel.sourceforge.net/
>>> _______________________________________________
>>> Rdkit-discuss mailing list
>>> [email protected]
>>> https://lists.sourceforge.net/lists/listinfo/rdkit-discuss
>>>
>>>
>>
>>
>> ------------------------------------------------------------------------------
>> Dive into the World of Parallel Programming The Go Parallel Website,
>> sponsored
>> by Intel and developed in partnership with Slashdot Media, is your hub
>> for all
>> things parallel software development, from weekly thought leadership
>> blogs to
>> news, videos, case studies, tutorials and more. Take a look and join the
>> conversation now. http://goparallel.sourceforge.net/
>> _______________________________________________
>> Rdkit-discuss mailing list
>> [email protected]
>> https://lists.sourceforge.net/lists/listinfo/rdkit-discuss
>>
>>
>
------------------------------------------------------------------------------
Dive into the World of Parallel Programming The Go Parallel Website, sponsored
by Intel and developed in partnership with Slashdot Media, is your hub for all
things parallel software development, from weekly thought leadership blogs to
news, videos, case studies, tutorials and more. Take a look and join the
conversation now. http://goparallel.sourceforge.net/
_______________________________________________
Rdkit-discuss mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/rdkit-discuss
