#sphinx-doc

[02sphinx] 07birkenfeld pushed 032 commits to 03master [+0/-0/±4] 13http://git.io/vYwO7

[02sphinx] 07mtreinish 039401f62 - Add support for converting checkmark unicode to latex symbol This commit adds an entry to the list of tex escapes for the checkmark unicode character. As part of this the use of the amssymb package is added which is required for the checkmark symbol among others. Closes #1959

[02sphinx] 07birkenfeld 034053ba7 - Merge pull request #1971 from mtreinish/fix-checkmark Add support for converting checkmark unicode to latex symbol

[02sphinx] 07birkenfeld pushed 031 commit to 03master [+0/-0/±2] 13http://git.io/vYw3J

[02sphinx] 07birkenfeld 0319a7dfd - move amssymb package require to .sty file

I'm trying to auto generate API docs to start. I have run sphinx-quickstart with docs/ as the folder for conf.py etc. I ran sphinx-autodoc with the output directory of docs/ when I move into docs and run "make html" The html generated doesn't seem to have any content from the docstrings.

Do you have to manually add the fileNames into index.rst?

Siecje: Autodoc needs directives like .. automodule:: or .. autoclass:: to generate anything, yes - see http://sphinx-doc.org/ext/autodoc.html

sdough: I added the files that sphinx-autodoc created. With .. autoclass:: I won't need to run sphinx-autodoc?

I think I got the extension autodoc confused with the... script? sphinx-autodoc.

well I added .. automodule:: in front of all my file names but now the docs are empty

Did you set the module name before that, or try specifying the module name like .. automodule:: path.to.module ?

It's not magic.

sdough: inside docs I have a bunch of files.rst and they have ..automodule:: inside them.

So in index.rst I guess I should just have the file names?

1) It's '.. automodule::' 2) You need to somehow specify the module name.

Read the docs, please.

sdough: I ran sphinx-autodoc it create a bunch of .rst files, if I add just the file name to index.rst it works. Inside each of the .rst files there is '.. automodule::'. If I add '.. automodule::' inside index.rst I don't see any of those modules in the ouput.

You have something that works? What is the thing you're trying to do, then?

You're trying to avoid needing to run sphinx-autodoc again?

sdough: I don't think I need to unless I add a new file?

Correct.

I do not understand the objective you are trying to get help with.

Just that I needed to add the file names to index.rst manually.

Without using automodule what should the rst file contain to describe methods

Siecje: See http://sphinx-doc.org/domains.html?highlight=cl...

sdough: Thanks

What is the recommended way to describe a parameter that is a dictionary? To describe the attributes and types.

Why not keyword arguments?

I find often a dictionary argument is more idomatically replaced with keyword arguments. I haven't seen a good way to document a dictionary argument like that.

sdough: thanks, about using keyword arguments it is an object representation with may contain another dict

In my .rst file I have https://dpaste.de/wtdb but after the description it is just displaying the rest of the text on one line.

You need more colons - see the example here: http://sphinx-doc.org/domains.html?highlight=cl...

sdough: Thanks again