search docstring info

Users Mailing List Archive
1

Hello,

I devellopp python codes in order to make a workflow
for proccessing seismogram (pre-processing, correlation,
analysis, etc...) for a project named whisper at Isterre
(Grenoble, France) .

Is there any way to obtain informations of the docstring that is used by obspy?

Xavier Briand

2

Hi,

just try this link http://docs.obspy.org/tutorial/index.html, hope it helps.

3

Hi Xavier,

I guess you are referring to the format of the docstring itself or? We
are using Sphinx (http://http://sphinx.pocoo.org/) to generate our
documentation pages - Sphinx uses reStructuredText
(reStructuredText Markup Specification)
as its markup language.

Cheers,
Robert

Hello,

I devellopp python codes in order to make a workflow for
proccessing seismogram (pre-processing, correlation, analysis,
etc...) for a project named whisper at Isterre (Grenoble, France)
.

Is there any way to obtain informations of the docstring that is
used by obspy?

Xavier Briand

- --

Dr. Robert Barsch

Ludwig-Maximilians-Universität München
Department of Earth and Environmental Sciences, Geophysics
Theresienstr. 41/IV
D-80333 Munich
Germany

Tel: +49 (0) 89 2180 4201
Fax: +49 (0) 89 2180 9942010
Mail: barsch@lmu.de

4

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi Xavier,

I guess you are referring to the format of the docstring itself or? We
are using Sphinx (http://http://sphinx.pocoo.org/) to generate our
documentation pages - Sphinx uses reStructuredText
(reStructuredText Markup Specification)
as its markup language.

Cheers,
Robert

ok, thanks, It is what I want to know!

I hesitate with docformat as javadoc or the small epytext.
Because it is "api oriented", I use epydoc but I want to use
tools close to yours. Sphinx is used by python, I am not
sure I need so much.

Xavier Briand

5

ok, thanks, It is what I want to know!

no problem

You should also take a look at the Sphinx tutorial found at
sampledoc tutorial — sampledoc 1.0 documentation - and there especially
into "Sphinx cheat sheet" and "Sphinx extensions for embedded plots,
math and more" - and ofc you could look right directly into the source
code of ObsPy - some rather well documented modules are obspy.core or
obspy.arclink.

Cheers,
Robert

- --

Dr. Robert Barsch

Ludwig-Maximilians-Universität München
Department of Earth and Environmental Sciences, Geophysics
Theresienstr. 41/IV
D-80333 Munich
Germany

Tel: +49 (0) 89 2180 4201
Fax: +49 (0) 89 2180 9942010
Mail: barsch@lmu.de

6

You should also take a look at the Sphinx tutorial found at
sampledoc tutorial — sampledoc 1.0 documentation - and there especially
into "Sphinx cheat sheet" and "Sphinx extensions for embedded plots,
math and more" - and ofc you could look right directly into the source
code of ObsPy - some rather well documented modules are obspy.core or
obspy.arclink.

Ok, I will try it, thanks for the subsections.
If anyone have a good tutorial or config don't hesitate!

Xavier Briand