How do you keep documentation so nice?

[Adam Hughes]

I really am impressed by this plt2rst.py module for autogenerating example
documentation!

I've been trying to implement it just to test it out and think I have it
setup right in terms of placement in my docs directory, I made an example
plot_test.py file in examples, but I'm confused on how to actually use the
plt2rst.py module.  Consider this line from that file:

    def setup(app):
        app.connect('builder-inited', generate_example_galleries)

        app.add_config_value('plot2rst_paths',
                         ('../examples', 'auto_examples'), True

When/how is this ever called?  The examples themselves don't use these
directives; so when is this found?

When I build in my make file, no auto_examples.html file is ever created in
my build directory.  So I'm thinking I'm not using this correctly.  Is
there another step besides just doing make build?


On Sun, Dec 7, 2014 at 7:22 PM, Adam Hughes <hughesadam87 at gmail.com> wrote:

> Thanks Juan.  It's funny, but I feel like writing documents is 10 times
> harder than writing software
>
> On Sun, Dec 7, 2014 at 7:17 PM, Juan Nunez-Iglesias <jni.soma at gmail.com>
> wrote:
>
>> Hahaha it's not that dumb! I personally have tried to dive into the doc
>> build process a few times but have found it quite opaque, so I wouldn't
>> mind if Stéfan and/or Tony elaborated a bit here about the build system! =)
>>
>> But as to drawing inspiration, I'm pretty sure it's all BSD, which means
>> you can draw even a bit more than that! =)
>>
>>
>>
>>
>> On Mon, Dec 8, 2014 at 11:14 AM, Adam Hughes <hughesadam87 at gmail.com>
>> wrote:
>>
>>>  I'm dumb.  It's clearly right there on your github page in "docs".
>>> Geez.
>>>
>>> It's ok if I draw inspiration from you guys, right?
>>>
>>> On Sun, Dec 7, 2014 at 7:11 PM, Adam Hughes <hughesadam87 at gmail.com>
>>> wrote:
>>>
>>>> Hi,
>>>>
>>>> I've been working with sphinx api-doc for autogenerating some
>>>> documentation for a package, and the output is a farcry from the nice,
>>>> super-slick layout that scikit-image has.  I saw that on the bottom of your
>>>> page, the docs are built with sphinx and bootstrap.  Is the source code for
>>>> the documentation available for perusing by chance?  I'd love to get some
>>>> insights on how you keep your page so nice and tidy!
>>>>
>>>> --
>>>> You received this message because you are subscribed to a topic in the
>>>> Google Groups "scikit-image" group.
>>>> To unsubscribe from this topic, visit
>>>> https://groups.google.com/d/topic/scikit-image/k5K6_vanZVI/unsubscribe.
>>>> To unsubscribe from this group and all its topics, send an email to
>>>> scikit-image+unsubscribe at googlegroups.com.
>>>> For more options, visit https://groups.google.com/d/optout.
>>>>
>>>
>>>  --
>>> You received this message because you are subscribed to the Google
>>> Groups "scikit-image" group.
>>> To unsubscribe from this group and stop receiving emails from it, send
>>> an email to scikit-image+unsubscribe at googlegroups.com.
>>> For more options, visit https://groups.google.com/d/optout.
>>>
>>
>>  --
>> You received this message because you are subscribed to a topic in the
>> Google Groups "scikit-image" group.
>> To unsubscribe from this topic, visit
>> https://groups.google.com/d/topic/scikit-image/k5K6_vanZVI/unsubscribe.
>> To unsubscribe from this group and all its topics, send an email to
>> scikit-image+unsubscribe at googlegroups.com.
>> For more options, visit https://groups.google.com/d/optout.
>>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scikit-image/attachments/20141208/8ef639c2/attachment.html>