Execute something like autodoc without run the code is posible?

[Juan Antonio Fernández Sánchez]

Hi everyone.
I'm new in Shinx and I have been few days trying of doc my little project with this tool, spending hours and hours without results.
I don't understand why sphinx need run my code when I use automodule to read the docstring in my files.
I don't want that Sphinx run my code, I only want that read the files and do the html web to show the doc.
In my project I have a lot of dependencies with other files and other tools and Sphinx only find problems to import this.
I really like look of pages that Shinx do, but I think isn't easy for begin.

Please, exist any way to doc my files without run the code? I only want doc, don't check anything else.

Thanks you so much for any help. :)

[Komiya Takeshi]

Hi,

Technically, it is possible to generate docs without execution.

But sphinx.ext.autodoc does not support the feature.

It might work combination of doxygen and breathe extension (but I'd never used them...)

Thanks,

Takeshi KOMIYA

2016年6月4日土曜日 20時54分32秒 UTC+9 Juan Antonio Fernández Sánchez:

[gilberto dos santos alves]

hi.

go step by step and you will understand what is going on.

symptom look at your config.py and verify details of your code.

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

--

gilberto dos santos alves
+55(11)9-8646-5049
sao paulo - sp - brasil

[Chris Barker]

yes, you need to run the code -- but not much -- it only needs to be importable.

I can understand that you want want to document, unfinished, not quite ready and working code, but if it can't even be imported, you may need to look at your development process :-)

-CHB

--

You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

--

Christopher Barker, Ph.D.
Oceanographer

Emergency Response Division
NOAA/NOS/OR&R            (206) 526-6959   voice
7600 Sand Point Way NE   (206) 526-6329   fax
Seattle, WA  98115       (206) 526-6317   main reception

Chris....@noaa.gov