Re: How do you keep documentation so nice?
Hi Adam On 2014-12-09 22:54:34, Adam Hughes <hughesadam87@gmail.com> wrote:
Nevermind guys, I was able to get it working through that sphinx-gallery link that Stefan set.
I'm not sure how--that repo still looks to be fairly empty! The process is: we run tools that generates .rst files, the rst files get compiled by Sphinx, during which the plots etc. get generated. The result is then pushed to a repository on GitHub. Easiest way to understand it is to run the script and examine the new files created. Stéfan
Stéfan,
I'm not sure how--that repo still looks to be fairly empty!
Huh??? You sent that link! LOL I was puzzled too but then saw the PR from the owner's "personal" fork of the repo, which I guess (no time to look at it yet) has a fair few resources.
the rst files get compiled by Sphinx, during which the plots etc. get generated.
I don't actually understand the process of generating plots in the case of hand-written docs. E.g. this image embed by Emmanuelle: https://github.com/scikit-image/scikit-image/blob/master/doc/source/user_gui... Is that generated from the code in the .rst file itself, or does she have to know (through non-automated means) that the auto-example produces the same image as is required in the rst? Juan.
Hi Juan On 2014-12-10 00:59:01, Juan Nunez-Iglesias <jni.soma@gmail.com> wrote:
Huh??? You sent that link! LOL I was puzzled too but then saw the PR from the owner's "personal" fork of the repo, which I guess (no time to look at it yet) has a fair few resources.
This is where the project is supposed to be maintained--I am following the discussions, and thought they just haven't committed any code. Now that I know differently I'll ask them to commit to that branch.
I don't actually understand the process of generating plots in the case of hand-written docs. E.g. this image embed by Emmanuelle:
https://github.com/scikit-image/scikit-image/blob/master/doc/source/user_gui...
She "cheated" a bit and included an image from the gallery.
Is that generated from the code in the .rst file itself, or does she have to know (through non-automated means) that the auto-example produces the same image as is required in the rst?
In this case, yes. Stéfan
On 2014-12-10 01:46:40, Juan Nunez-Iglesias <jni.soma@gmail.com> wrote:
If I want to include my own non-gallery image, should I generate it manually, and if so, where should I put it?
In that case, you can use the "plot" directive (see `plot_directive.py` in the `doc/ext` directory. Sorry that you have to pry all of this out of me--I am also rusty since I don't use it that often. Stéfan
Hey guys, Thanks for all of your help! Here is my working version: http://hugadams.github.io/scikit-spectra/ Check out the IPython GUI video if you're interested. On Tue, Dec 9, 2014 at 7:09 PM, Stefan van der Walt <stefan@sun.ac.za> wrote:
On 2014-12-10 01:46:40, Juan Nunez-Iglesias <jni.soma@gmail.com> wrote:
If I want to include my own non-gallery image, should I generate it manually, and if so, where should I put it?
In that case, you can use the "plot" directive (see `plot_directive.py` in the `doc/ext` directory. Sorry that you have to pry all of this out of me--I am also rusty since I don't use it that often.
Stéfan
-- 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@googlegroups.com. For more options, visit https://groups.google.com/d/optout.
participants (3)
-
Adam Hughes -
Juan Nunez-Iglesias -
Stefan van der Walt