Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-10-06 Thread c.buhtz
I am sorry, but the html pages are still empty. I only see the project name but no sub modules, methodes, functions or something else. This is the output while make $ make html Sphinx v1.8.1 in Verwendung Lade pickle Umgebung...erledigt [autosummary] generating autosummary for: index.rst

Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-10-06 Thread Luc Saffre
Your project was almost perfect, there was only one detail missing: in every `__init___.py` you must explicitly tell autosummary which subpackages you want to include. See my diff below. HTH Luc $ git diff diff --git a/buhtzsphinx/__init__.py b/buhtzsphinx/__init__.py index 76a9a4a..77157f5

Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-10-04 Thread c.buhtz
Dear Luc, thanks for your explanations. I updated my code and pushed it to upstream. But it still not working here. Can you give it a try with my code? -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop

Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-10-03 Thread Luc Saffre
Yes, atelier simplifies my life but for you it makes things more difficult to understand... I guess that you should have a look at the atelier.sphinxconf.configure() function: https://github.com/lino-framework/atelier/blob/master/atelier/sphinxconf/__init__.py#L64 configure() updates the

Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-10-03 Thread c.buhtz
Dear Luc, thank you for this valuable hint. Your example doc looks awesome and exactly as this what was in my mind. The test with my own code did not work. https://gitlab.com/buhtz/buhtz-sphinx I always do a "make html" in the doc-directory to generate the doc. But I have not copied your

Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-10-01 Thread c.buhtz
I also found the autoapi extension. But even this is far away from being "auto" because I have to write all members into the __all__ variable in each module. The point for me in "auto" is I don'T want to think about if I have to add a new created member to an __all__ variable or write it into an

Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-09-27 Thread c . buhtz
Dear Matthias, I fixed the module name and added a autodoc command to the rst file - see in upstream. The result is the same. The "module index" in the docs is empty. -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this

Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-09-27 Thread Matthias Geier
On Thu, Sep 27, 2018 at 12:17 AM c.buhtz wrote: > On 2018-09-25 09:09 Matthias Geier wrote: > > In order for other people here to reproduce your problem, it is > > typically easier if you provide a very minimal but fully working > > example. > > Please see this MWE. >

Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-09-27 Thread c . buhtz
Dear Matthias, thanks for your message. Am 26.09.2018 18:19 schrieb Matthias Geier: But I think it makes sense to manually select which modules you want to be scanned for your documentation. You might have some internal modules which you don't want to appear in the docs, for example. You

Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-09-26 Thread c.buhtz
On 2018-09-25 09:09 Matthias Geier wrote: > In order for other people here to reproduce your problem, it is > typically easier if you provide a very minimal but fully working > example. Please see this MWE. https://gitlab.com/buhtz/buhtz-sphinx I didn't modify the rst file. I would expect that

Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-09-26 Thread Matthias Geier
On Tue, Sep 25, 2018 at 11:57 PM c.buhtz wrote: > > Dear Matthias, > > thank you for your tips. > > Let me ask the general question. Why do I have to name explicit a > module, function, method or member? Well I'm not involved in the development of sphinx.ext.autodoc, so I don't know the real

Re: [sphinx-users] First steps with Pyhton and Sphinx

2018-09-25 Thread c.buhtz
Dear Matthias, thank you for your tips. Let me ask the general question. Why do I have to name explicit a module, function, method or member? When using a tool like Sphinx I would assume that the tool scan all my code (all py-files) and create the html-doc out of it depending on the